FreeCalypso > hg > fc-tourmaline

comparison src/cs/services/lls/lls_api.h @ 0:4e78acac3d88

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/{condat,cs,gpf,nucleus}: import from Selenite
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 16 Oct 2020 06:23:26 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:4e78acac3d88
1 /**
2 * @file lls_api.h
3 *
4 * API Definition for LLS (Low Level Servies) Service.
5 *
6 * This file gathers all the constants, structure and functions declaration
7 * useful for a LLS service user.
8 *
9 * @author Laurent Sollier (l-sollier@ti.com)
10 * @version 0.1
11 */
12
13 /*
14 * History:
15 *
16 * Date Author Modification
17 * ----------------------------------------
18 * 03/12/2002 L Sollier Create
19 *
20 *
21 * (C) Copyright 2002 by Texas Instruments Incorporated, All Rights Reserved
22 */
23
24 #ifndef _LLS_API_H_
25 #define _LLS_API_H_
26
27
28 #include "rv/rv_general.h"
29
30 /**
31 * @name External types
32 *
33 * Types used in API.
34 *
35 */
36 /*@{*/
37
38 /** Definition of available equipment, ... for D-Sample
39 */
40 #define LLS_LED_A 0x01
41 #define LLS_BACKLIGHT 0x02
42 #define LLS_PRECHARGE_LED 0x03
43
44 /*@}*/
45
46 typedef UINT8 T_LLS_EQUIPMENT;
47
48 /**
49 * @name API functions
50 *
51 * API functions declarations.
52 */
53 /*@{*/
54
55 /**
56 * function: lls_switch_on
57 *
58 * This function switch on an equipment.
59 *
60 * @param equipment_sort equipment sort.
61 * @return
62 * - RV_OK if operation is successful,
63 * - RV_INVALID_PARAMETER if one parameter is incorrect,
64 * - RV_NOT_SUPPORTED
65 *
66 */
67 T_RV_RET lls_switch_on(T_LLS_EQUIPMENT equipment_sort);
68
69
70 /**
71 * function: lls_switch_off
72 *
73 * This function switch off an equipment.
74 *
75 * @param equipment_sort equipment sort.
76 * @return
77 * - RV_OK if operation is successful,
78 * - RV_INVALID_PARAMETER if one parameter is incorrect,
79 * - RV_NOT_SUPPORTED
80 *
81 */
82 T_RV_RET lls_switch_off(T_LLS_EQUIPMENT equipment_sort);
83
84
85 /*@}*/
86
87
88
89
90 #endif /* #ifndef _LLS_API_H_ */