FreeCalypso > hg > fc-tourmaline
annotate src/g23m-gprs/sm/sm_timer_handler.h @ 50:a62e5bf88434
first round of documentation
| author | Mychaela Falconia <falcon@freecalypso.org> | 
|---|---|
| date | Sun, 18 Oct 2020 18:08:15 +0000 | 
| parents | fa8dc04885d8 | 
| children | 
| rev | line source | 
|---|---|
| 1 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 1 /*---------------------------------------------------------------------------- | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 2 | Project : 3G PS | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 3 | Module : SM | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 4 +----------------------------------------------------------------------------- | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 5 | Copyright 2003 Texas Instruments. | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 6 | All rights reserved. | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 7 | | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 8 | This file is confidential and a trade secret of Texas | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 9 | Instruments . | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 10 | The receipt of or possession of this file does not convey | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 11 | any rights to reproduce or disclose its contents or to | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 12 | manufacture, use, or sell anything it may describe, in | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 13 | whole, or in part, without the specific written consent of | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 14 | Texas Instruments. | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 15 +----------------------------------------------------------------------------- | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 16 | Purpose: 3G Timer handler function definitions in the SM entity. | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 17 | For design details, see: | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 18 | 8010.908 SM Detailed Specification | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 19 +---------------------------------------------------------------------------*/ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 20 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 21 /*==== DECLARATION CONTROL =================================================*/ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 22 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 23 #ifndef SM_TIMER_HANDLER_H | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 24 #define SM_TIMER_HANDLER_H | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 25 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 26 /*==== INCLUDES =============================================================*/ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 27 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 28 #include "sm.h" | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 29 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 30 /*==== CONSTS ===============================================================*/ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 31 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 32 #define NWSM_T3380_TIMEOUT 30000 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 33 #define NWSM_T3381_TIMEOUT 8000 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 34 #define NWSM_T3390_TIMEOUT 8000 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 35 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 36 #define NWSM_MAX_TIMEOUTS 5 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 37 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 38 /*==== TYPES ================================================================*/ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 39 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 40 typedef enum { | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 41 SM_TIMER_NONE, | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 42 SM_TIMER_T3380, | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 43 SM_TIMER_T3381, | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 44 SM_TIMER_T3390 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 45 } T_SM_TIMER_TYPE; | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 46 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 47 /*==== EXPORTS ==============================================================*/ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 48 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 49 extern void sm_timer_start (struct T_SM_CONTEXT_DATA *context, T_SM_TIMER_TYPE timer); | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 50 extern void sm_timer_restart(struct T_SM_CONTEXT_DATA *context); | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 51 extern void sm_timer_stop (struct T_SM_CONTEXT_DATA *context); | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 52 | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 53 #endif /* SM_TIMER_HANDLER_H */ | 
| 
fa8dc04885d8
src/g23m-*: import from Magnetite
 Mychaela Falconia <falcon@freecalypso.org> parents: diff
changeset | 54 /*==== END OF FILE ==========================================================*/ | 
