FreeCalypso > hg > tcs211-l1-reconst
annotate chipsetsw/services/lls/lls_api.h @ 294:ff9fbb4a4ecf
l1p_asyn.c: reconstruction complete, perfect match to TCS211 object
| author | Mychaela Falconia <falcon@freecalypso.org> | 
|---|---|
| date | Mon, 02 Oct 2017 05:57:54 +0000 | 
| parents | 509db1a7b7b8 | 
| children | 
| rev | line source | 
|---|---|
| 0 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 1 /** | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 2 * @file lls_api.h | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 3 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 4 * API Definition for LLS (Low Level Servies) Service. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 5 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 6 * This file gathers all the constants, structure and functions declaration | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 7 * useful for a LLS service user. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 8 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 9 * @author Laurent Sollier (l-sollier@ti.com) | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 10 * @version 0.1 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 11 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 12 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 13 /* | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 14 * History: | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 15 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 16 * Date Author Modification | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 17 * ---------------------------------------- | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 18 * 03/12/2002 L Sollier Create | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 19 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 20 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 21 * (C) Copyright 2002 by Texas Instruments Incorporated, All Rights Reserved | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 22 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 23 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 24 #ifndef _LLS_API_H_ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 25 #define _LLS_API_H_ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 26 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 27 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 28 #include "rv/rv_general.h" | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 29 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 30 /** | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 31 * @name External types | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 32 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 33 * Types used in API. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 34 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 35 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 36 /*@{*/ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 37 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 38 /** Definition of available equipment, ... for D-Sample | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 39 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 40 #define LLS_LED_A 0x01 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 41 #define LLS_BACKLIGHT 0x02 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 42 #define LLS_PRECHARGE_LED 0x03 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 43 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 44 /*@}*/ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 45 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 46 typedef UINT8 T_LLS_EQUIPMENT; | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 47 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 48 /** | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 49 * @name API functions | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 50 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 51 * API functions declarations. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 52 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 53 /*@{*/ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 54 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 55 /** | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 56 * function: lls_switch_on | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 57 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 58 * This function switch on an equipment. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 59 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 60 * @param equipment_sort equipment sort. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 61 * @return | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 62 * - RV_OK if operation is successful, | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 63 * - RV_INVALID_PARAMETER if one parameter is incorrect, | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 64 * - RV_NOT_SUPPORTED | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 65 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 66 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 67 T_RV_RET lls_switch_on(T_LLS_EQUIPMENT equipment_sort); | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 68 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 69 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 70 /** | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 71 * function: lls_switch_off | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 72 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 73 * This function switch off an equipment. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 74 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 75 * @param equipment_sort equipment sort. | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 76 * @return | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 77 * - RV_OK if operation is successful, | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 78 * - RV_INVALID_PARAMETER if one parameter is incorrect, | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 79 * - RV_NOT_SUPPORTED | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 80 * | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 81 */ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 82 T_RV_RET lls_switch_off(T_LLS_EQUIPMENT equipment_sort); | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 83 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 84 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 85 /*@}*/ | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 86 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 87 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 88 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 89 | 
| 
509db1a7b7b8
initial import: leo2moko-r1
 Space Falcon <falcon@ivan.Harhan.ORG> parents: diff
changeset | 90 #endif /* #ifndef _LLS_API_H_ */ | 
