1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
/******************************************************************************
**
* @brief header file for KBI.
*
*******************************************************************************
*
* provide APIs for accessing KBI
******************************************************************************/
#ifndef _KBI_H_
#define _KBI_H_
#ifdef __cplusplus
extern "C" {
#endif
/******************************************************************************
* Includes
******************************************************************************/
/******************************************************************************
* Constants
******************************************************************************/
/*!
* @brief KBI MODE select enum.
*
*/
typedef enum
{
KBI_MODE_EDGE_ONLY = 0, /*!< select edge only mode */
KBI_MODE_EDGE_LEVEL /*!< select both edge and level mode */
}KBI_ModeType;
/*!
* @brief KBI Edge select enum.
*
*/
typedef enum
{
KBI_FALLING_EDGE_LOW_LEVEL = 0, /*!< select falling edge and/or low level */
KBI_RISING_EDGE_HIGH_LEVEL /*!< select rising edge and/or high level */
}KBI_EdgeType;
/******************************************************************************
* Macros
******************************************************************************/
/******************************************************************************
* KBI module max number and port pins definition
*
*//*! @addtogroup kbi_macro
* @{
*******************************************************************************/
#define KBI_MAX_NO 2 /*!< max number of modules */
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
#define KBI_MAX_PINS_PER_PORT 8 /*!< max number of pins */
#elif defined(CPU_NV32M4)
#define KBI_MAX_PINS_PER_PORT 32 /*!< max number of pins */
#endif
/*! @} End of kbi_macro */
/******************************************************************************
* Types
******************************************************************************/
/*! @brief KBI_CALLBACK function declaration */
typedef void (*KBI_CallbackType)(void);
/*! @} End of kbi_callback */
/******************************************************************************
* KBI pin config struct
*
*//*! @addtogroup kbi_pinconfigstruct
* @{
*******************************************************************************/
/*!
* @brief KBI pin enable and edge select struct.
*
*/
typedef struct
{
uint8_t bEdge : 1; /*!< edge/level select bit */
uint8_t bEn : 1; /*!< pin enable bit */
uint8_t bRsvd : 6; /*!< reserved */
} KBI_PinConfigType;
/*! @} End of kbi_pinconfigstruct */
/******************************************************************************
* KBI config struct
*
*//*! @addtogroup kbi_configstruct
* @{
*******************************************************************************/
/*!
* @brief KBI status and control struct.
*
*/
typedef struct
{
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
struct
{
uint8_t bMode : 1; /*!< KBI detection mode select */
uint8_t bIntEn : 1; /*!< KBI interrupt enable bit */
uint8_t bRsvd : 6; /*!< reserved */
} sBits;
#elif defined(CPU_NV32M4)
struct
{
uint32_t bMode : 1; /*!< KBI detection mode select */
uint32_t bIntEn : 1; /*!< KBI interrupt enable bit */
uint32_t bRsvd2 : 2; /*!< reserved */
uint32_t bKbspEn : 1; /*!<Real KBI_SP register enable*/
uint32_t bRstKbsp: 1; /*!<Reset KBI_SP register*/
uint32_t bRsvd26 : 26; /*!< reserved */
} sBits;
#endif
KBI_PinConfigType sPin[KBI_MAX_PINS_PER_PORT];
} KBI_ConfigType, *KBI_ConfigTypePtr;
/*! @} End of kbi_configstruct */
/******************************************************************************
* Global variables
******************************************************************************/
/*!
* inline functions
*/
/******************************************************************************
* KBI api list
*
*//*! @addtogroup kbi_api_list
* @{
*******************************************************************************/
/*****************************************************************************//*!
*
* @brief set detect falling edge only.
*
* @param[in] pKBI pointer to KBI module.
* @param[in] PinMasks indicate pin numbers.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_DetectRisingEdge.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE void KBI_DetectFallingEdge(KBI_Type *pKBI, uint8_t PinMasks)
#elif defined(CPU_NV32M4)
__STATIC_INLINE void KBI_DetectFallingEdge(KBI_Type *pKBI, uint32_t PinMasks)
#endif
{
pKBI->SC &= ~KBI_SC_KBMOD_MASK;
pKBI->ES &= ~(PinMasks);
}
/*****************************************************************************//*!
*
* @brief set detect falling edge only.
*
* @param[in] pKBI pointer to KBI module.
* @param[in] PinMasks indicate pin numbers.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_DetectFallingEdge.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE void KBI_DetectRisingEdge(KBI_Type *pKBI, uint8_t PinMasks)
#elif defined(CPU_NV32M4)
__STATIC_INLINE void KBI_DetectRisingEdge(KBI_Type *pKBI, uint32_t PinMasks)
#endif
{
pKBI->SC &= ~KBI_SC_KBMOD_MASK;
pKBI->ES |= (PinMasks);
}
/*****************************************************************************//*!
*
* @brief set detect falling edge only.
*
* @param[in] pKBI pointer to KBI module.
* @param[in] PinMasks indicate pin number/mask.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_DetectFallingEdgeLowLevel.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE void KBI_DetectRisingEdgeHighLevel(KBI_Type *pKBI, uint8_t PinMasks)
#elif defined(CPU_NV32M4)
__STATIC_INLINE void KBI_DetectRisingEdgeHighLevel(KBI_Type *pKBI, uint32_t PinMasks)
#endif
{
pKBI->SC |= KBI_SC_KBMOD_MASK;
pKBI->ES |= (PinMasks);
}
/*****************************************************************************//*!
*
* @brief set detect falling edge only.
*
* @param[in] pKBI pointer to KBI module.
* @param[in] PinMasks indicate pin number/mask.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_DetectRisingEdgeHighLevel.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE void KBI_DetectFallingEdgeLowLevel(KBI_Type *pKBI, uint8_t PinMasks)
#elif defined(CPU_NV32M4)
__STATIC_INLINE void KBI_DetectFallingEdgeLowLevel(KBI_Type *pKBI, uint32_t PinMasks)
#endif
{
pKBI->SC |= KBI_SC_KBMOD_MASK;
pKBI->ES &= ~(PinMasks);
}
/*****************************************************************************//*!
*
* @brief enable the pin specified.
*
* @param[in] pKBI pointer to KBI module.
* @param[in] PinMasks indicate pin number/mask.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_Disable.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE void KBI_Enable(KBI_Type *pKBI, uint8_t PinMasks)
#elif defined(CPU_NV32M4)
__STATIC_INLINE void KBI_Enable(KBI_Type *pKBI, uint32_t PinMasks)
#endif
{
pKBI->PE |= (PinMasks);
}
/*****************************************************************************//*!
*
* @brief disable the pin specified.
*
* @param[in] pKBI pointer to KBI module.
* @param[in] PinMasks indicate pin number/mask.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_Enable.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE void KBI_Disable(KBI_Type *pKBI, uint8_t PinMasks)
#elif defined(CPU_NV32M4)
__STATIC_INLINE void KBI_Disable(KBI_Type *pKBI, uint32_t PinMasks)
#endif
{
pKBI->PE &= ~(PinMasks);
}
/*****************************************************************************//*!
*
* @brief enable the corresponding interrupt.
*
* @param[in] pKBI pointer to KBI module.
*
* @return none.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_DisableInt.
*
*****************************************************************************/
__STATIC_INLINE void KBI_EnableInt(KBI_Type *pKBI)
{
pKBI->SC |= KBI_SC_KBIE_MASK;
}
/*****************************************************************************//*!
*
* @brief disable the corresponding interrupt.
*
* @param[in] pKBI pointer to KBI module.
*
* @return none.
*
* @ Pass/ Fail criteria: none
*
* @see KBI_EnableInt.
*
*****************************************************************************/
__STATIC_INLINE void KBI_DisableInt(KBI_Type *pKBI)
{
pKBI->SC &= ~KBI_SC_KBIE_MASK;
}
/*****************************************************************************//*!
*
* @brief Get the corresponding status flag bits.
*
* @param[in] pKBI pointer to KBI module.
*
* @return uint8_t.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_ClrFlags.
*
*****************************************************************************/
#if defined(CPU_NV32)|| defined(CPU_NV32M3)
__STATIC_INLINE uint8_t KBI_GetFlags(KBI_Type *pKBI)
#elif defined(CPU_NV32M4)
__STATIC_INLINE uint32_t KBI_GetFlags(KBI_Type *pKBI)
#endif
{
return (pKBI->SC & KBI_SC_KBF_MASK);
}
/*****************************************************************************//*!
*
* @brief clear the corresponding status flag bits.
*
* @param[in] pKBI pointer to KBI module
*
* @return none.
*
* @ Pass/ Fail criteria: none
*
* @see KBI_GetFlags.
*
*****************************************************************************/
__STATIC_INLINE void KBI_ClrFlags(KBI_Type *pKBI)
{
pKBI->SC |= KBI_SC_KBACK_MASK;
}
#if defined(CPU_NV32M4)
/*****************************************************************************//*!
*
* @brief Real KBI_SP register enable.
*
* @param[in] pKBI pointer to KBI module
*
* @return none.
*
* @ Pass/ Fail criteria: none
*
* @see The real ETMe value of Keyboard source pin to be read.
*
*****************************************************************************/
__STATIC_INLINE void KBI_SPEnable(KBI_Type *pKBI)
{
pKBI->SC |= KBI_SC_KBSPEN_MASK;
}
/*****************************************************************************//*!
*
* @brief Get KBI source pin register fields.
*
* @param[in] pKBI pointer to KBI module.
*
* @return uint32_t.
*
* @ Pass/ Fail criteria: none.
*
* @see KBI_GetSP.
*
*****************************************************************************/
__STATIC_INLINE uint32_t KBI_GetSP(KBI_Type *pKBI)
{
return (pKBI->SP & KBI_SP_SP_MASK);
}
/*****************************************************************************//*!
*
* @brief Reset KBI_SP register.
*
* @param[in] pKBI pointer to KBI module
*
* @return none.
*
* @ Pass/ Fail criteria: none
*
* @see KBI_RstSP.
*
*****************************************************************************/
__STATIC_INLINE void KBI_RstSP(KBI_Type *pKBI)
{
pKBI->SC |= KBI_SC_RSTKBSP_MASK;
}
#endif
/*! @} End of kbi_api_list */
/******************************************************************************
* Global functions
******************************************************************************/
void KBI_Init(KBI_Type *pKBI, KBI_ConfigType *pConfig);
void KBI_SetCallback(KBI_Type *pKBI, KBI_CallbackType pfnCallback);
#ifdef __cplusplus
}
#endif
#endif
|
