FreeCalypso > hg > ffs-editor
diff src/cs/services/lls/lls_api.h @ 0:92470e5d0b9e
src: partial import from FC Selenite
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Fri, 15 May 2020 01:28:16 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/cs/services/lls/lls_api.h Fri May 15 01:28:16 2020 +0000 @@ -0,0 +1,90 @@ +/** + * @file lls_api.h + * + * API Definition for LLS (Low Level Servies) Service. + * + * This file gathers all the constants, structure and functions declaration + * useful for a LLS service user. + * + * @author Laurent Sollier (l-sollier@ti.com) + * @version 0.1 + */ + +/* + * History: + * + * Date Author Modification + * ---------------------------------------- + * 03/12/2002 L Sollier Create + * + * + * (C) Copyright 2002 by Texas Instruments Incorporated, All Rights Reserved + */ + +#ifndef _LLS_API_H_ +#define _LLS_API_H_ + + +#include "rv/rv_general.h" + +/** + * @name External types + * + * Types used in API. + * + */ +/*@{*/ + +/** Definition of available equipment, ... for D-Sample + */ +#define LLS_LED_A 0x01 +#define LLS_BACKLIGHT 0x02 +#define LLS_PRECHARGE_LED 0x03 + +/*@}*/ + +typedef UINT8 T_LLS_EQUIPMENT; + +/** + * @name API functions + * + * API functions declarations. + */ +/*@{*/ + +/** + * function: lls_switch_on + * + * This function switch on an equipment. + * + * @param equipment_sort equipment sort. + * @return + * - RV_OK if operation is successful, + * - RV_INVALID_PARAMETER if one parameter is incorrect, + * - RV_NOT_SUPPORTED + * + */ +T_RV_RET lls_switch_on(T_LLS_EQUIPMENT equipment_sort); + + +/** + * function: lls_switch_off + * + * This function switch off an equipment. + * + * @param equipment_sort equipment sort. + * @return + * - RV_OK if operation is successful, + * - RV_INVALID_PARAMETER if one parameter is incorrect, + * - RV_NOT_SUPPORTED + * + */ +T_RV_RET lls_switch_off(T_LLS_EQUIPMENT equipment_sort); + + +/*@}*/ + + + + +#endif /* #ifndef _LLS_API_H_ */ \ No newline at end of file