FreeCalypso > hg > fc-tourmaline

comparison src/cs/services/lls/lls_i.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_i.h
3 *
4 * Declaration of internal function for LLS service.
5 *
6 * @author Laurent Sollier (l-sollier@ti.com)
7 * @version 0.1
8 */
9
10 /*
11 * History:
12 *
13 * Date Author Modification
14 * ----------------------------------------
15 * 03/12/2002 L Sollier Create
16 *
17 *
18 * (C) Copyright 2002 by Texas Instruments Incorporated, All Rights Reserved
19 */
20
21 #ifndef _LLS_I_H_
22 #define _LLS_I_H_
23
24 #include "lls/lls_api.h"
25
26 #include "rv/rv_general.h"
27 #include "rvm/rvm_use_id_list.h"
28
29
30 /* Macro definition for sending trace */
31 #define LLS_SEND_TRACE(text,level) rvf_send_trace(text, sizeof(text)-1, NULL_PARAM, level, LLS_USE_ID )
32 #define LLS_SEND_TRACE_PARAM(text,param,level) rvf_send_trace(text, sizeof(text)-1, param, level, LLS_USE_ID )
33
34
35 /* Definition of ON/OFF for an equipment */
36 #define SWITCH_ON 1
37 #define SWITCH_OFF 0
38
39
40 /**
41 * @name Internal functions
42 *
43 */
44 /*@{*/
45
46 /**
47 * function: lls_callback_equipment_status
48 *
49 * This function is called by SPI task to get the status of the equipment.
50 *
51 * @param equipment_status equipment status.
52 *
53 */
54 void lls_callback_equipment_status(UINT16* equipment_status);
55
56 /**
57 * function: lls_initialize
58 *
59 * This function is called by Riviera environment to initialize the SWE.
60 *
61 *
62 * @return
63 * - RV_OK if operation is successfull
64 * - RV_INTERNAL_ERR if an internal error occur
65 */
66 T_RV_RET lls_initialize(void);
67
68 /**
69 * function: lls_kill_service
70 *
71 * This function is called by Riviera environment to kill the SWE.
72 *
73 *
74 * @return
75 * - RV_OK if operation is successfull
76 * - RV_INTERNAL_ERR if an internal error occur
77 */
78 T_RV_RET lls_kill_service(void);
79
80 /**
81 * function: lls_manage_equipment
82 *
83 * This function manage the switch ON /switch OFF of the equipment.
84 *
85 * @param equipment_index index of the equipment in the table of the availabble equipments.
86 * @param action Action to perform on the equipment (switch ON or switch OFF).
87 *
88 * @return
89 * - RV_OK if operation is successfull
90 */
91 T_RV_RET lls_manage_equipment(UINT8 equipment_index, UINT8 action);
92
93 /**
94 * function: lls_search_index
95 *
96 * This function retrieve the index of the equipment in the table from the equipment number
97 * defined in the API
98 *
99 * @param equipment Equipment number as defined in the API.
100 * @param equipment_index (OUT) Action to perform on the equipment (switch ON or switch OFF).
101 *
102 * @return
103 * - RV_OK if operation is successfull
104 * - RV_INVALID_PARAMETER if the equipment number doesn't exist.
105 */
106 T_RV_RET lls_search_index(T_LLS_EQUIPMENT equipment, UINT8* equipment_index);
107
108
109 /*@}*/
110 #endif /* #ifndef _LLS_I_H_ */