FreeCalypso > hg > fc-selenite

comparison src/cs/services/mks/mks_i.h @ 0:b6a5e36de839

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
src/cs: initial import from Magnetite
author Mychaela Falconia <falcon@freecalypso.org>
date Sun, 15 Jul 2018 04:39:26 +0000
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:b6a5e36de839
1 /**
2 * @file mks_i.h
3 *
4 * Declaration of internal function for MKS 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 * 11/19/2001 L Sollier Create
16 *
17 *
18 * (C) Copyright 2001 by Texas Instruments Incorporated, All Rights Reserved
19 */
20
21 #ifndef _MKS_I_H_
22 #define _MKS_I_H_
23
24 #include "mks/mks_api.h"
25 #include "mks/mks_messages_i.h"
26
27 /* Macro definition for sending trace */
28 #define MKS_SEND_TRACE(text,level) rvf_send_trace(text, sizeof(text)-1, NULL_PARAM, level, MKS_USE_ID )
29 #define MKS_SEND_TRACE_PARAM(text,param,level) rvf_send_trace(text, sizeof(text)-1, param, level, MKS_USE_ID )
30
31
32 /**
33 * @name Internal functions
34 *
35 */
36 /*@{*/
37
38 /**
39 * function: mks_add_key_sequence_i
40 *
41 * This function add a magic key sequence.
42 *
43 * @param infos_key_sequence_p Key sequence informations.
44 *
45 * @return
46 * - RV_OK if operation is successfull
47 * - RV_INTERNAL_ERR if operation cannot be completed
48 * - RV_MEMORY_ERR if memory reach its size limit.
49 */
50 T_RV_RET mks_add_key_sequence_i(T_MKS_INFOS_KEY_SEQUENCE_MSG* infos_key_sequence_p);
51
52
53 /**
54 * function: mks_remove_key_sequence_i
55 *
56 * This function remove a magic key sequence.
57 *
58 * @param remove_key_sequence_p Key sequence name.
59 *
60 * @return
61 * - RV_OK
62 */
63 T_RV_RET mks_remove_key_sequence_i(T_MKS_REMOVE_KEY_SEQUENCE_MSG* remove_key_sequence_p);
64
65
66 /**
67 * function: mks_check_key_sequence
68 *
69 * This function is called when a key is pressed and check if a magic
70 * key sequence is completed.
71 *
72 * @param key_event_p Key event message.
73 *
74 */
75 void mks_check_key_sequence(T_KPD_KEY_EVENT_MSG* key_event_p);
76
77
78 /**
79 * function: mks_send_key_sequence_completed_msg
80 *
81 * Send a message that magic key sequence is completed.
82 *
83 * @param completion_level - MKS_SEQUENCE_COMPLETED:
84 * Call subscriber when magic key sequence is completed,
85 * - MKS_POST_SEQUENCE:
86 * Call subscriber after magic key sequence is completed
87 * @param key_id Virtual key Id pressed.
88 * @param return_path Return path used to notify the subscriber.
89 * @param name Name of the key sequence.
90 */
91 void mks_send_key_sequence_completed_msg(UINT8 completion_level,
92 T_KPD_VIRTUAL_KEY_ID key_id,
93 T_RV_RETURN return_path,
94 char* name);
95
96
97 /**
98 * function: mks_reset_sequence
99 *
100 * This function is called when timer 0 expire, to reset all
101 * key sequence.
102 *
103 */
104 void mks_reset_sequence(void);
105
106
107 /**
108 * function: mks_initialize_swe
109 *
110 * This function is called at the initialization of the SWE.
111 * It only subscribe to the keypad.
112 *
113 */
114 void mks_initialize_swe(void);
115
116
117 /**
118 * function: mks_stop_swe
119 *
120 * This function is called when SWE is stopped,
121 * It unsubscribe from the keypad
122 *
123 */
124 void mks_stop_swe(void);
125
126
127
128 /*@}*/
129 #endif /* #ifndef _MKS_I_H_ */