FreeCalypso > hg > freecalypso-sw
annotate gsm-fw/riviera/rv_template/xxx_api.h @ 328:5d9001f0c3aa
fc-sendsp: written, compiles
| author | Michael Spacefalcon <msokolov@ivan.Harhan.ORG> | 
|---|---|
| date | Sun, 20 Apr 2014 23:14:35 +0000 | 
| parents | afceeeb2cba1 | 
| children | 
| rev | line source | 
|---|---|
| 
118
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
1 /** | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
2 * @file xxx_api.h | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
3 * | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
4 * API Definition for XXX SWE. | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
5 * | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
6 * @author Your name here (your_email_here) | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
7 * @version 0.1 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
8 */ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
9 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
10 /* | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
11 * History: | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
12 * | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
13 * Date Author Modification | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
14 * ------------------------------------------------------------------- | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
15 * // Create. | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
16 * | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
17 * (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
18 */ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
19 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
20 #ifndef __XXX_API_H_ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
21 #define __XXX_API_H_ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
22 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
23 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
24 #include "rvm/rvm_gen.h" /* Generic RVM types and functions. */ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
25 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
26 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
27 #ifdef __cplusplus | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
28 extern "C" | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
29 { | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
30 #endif | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
31 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
32 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
33 /** | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
34 * @name XXX Return type and return values. | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
35 * | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
36 * Currently they are the standard RV return types, but they may | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
37 * be customized in the future. | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
38 */ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
39 /*@{*/ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
40 typedef T_RV_RET T_XXX_RETURN; | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
41 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
42 #define XXX_OK RV_OK | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
43 #define XXX_NOT_SUPPORTED RV_NOT_SUPPORTED | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
44 #define XXX_MEMORY_ERR RV_MEMORY_ERR | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
45 #define XXX_INTERNAL_ERR RV_INTERNAL_ERR | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
46 /*@}*/ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
47 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
48 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
49 /** | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
50 * @name API functions | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
51 * | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
52 * API functions declarations (bridge functions). | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
53 */ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
54 /*@{*/ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
55 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
56 T_XXX_RETURN xxx_send_sample (); | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
57 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
58 /*@}*/ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
59 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
60 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
61 #ifdef __cplusplus | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
62 } | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
63 #endif | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
64 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
65 | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
66 #endif /*__XXX_API_H_*/ | 
| 
 
21de8d8e6ea7
checking in Riviera code from the Sotomodem version
 
Michael Spacefalcon <msokolov@ivan.Harhan.ORG> 
parents:  
diff
changeset
 | 
67 | 
