summaryrefslogtreecommitdiff
path: root/bsp/essemi/es32f369x/libraries/ES32F36xx_ALD_StdPeriph_Driver/Include/ald_can.h
blob: 7fdc16327f38ab86a0d2162c2f008278437cffb9 (plain)
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
/**
  ******************************************************************************
  * @file    ald_can.h
  * @brief   Header file of CAN Module driver.
  *
  * @version V1.0
  * @date    16 Apr 2019
  * @author  AE Team
  * @note
  *          Change Logs:
  *          Date            Author          Notes
  *          16 Apr 2019     AE Team         The first version
  *
  * Copyright (C) Shanghai Eastsoft Microelectronics Co. Ltd. All rights reserved.
  *
  * SPDX-License-Identifier: Apache-2.0
  *
  * Licensed under the Apache License, Version 2.0 (the License); you may
  * not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  **********************************************************************************
  */

#ifndef __ALD_CAN_H
#define __ALD_CAN_H

#ifdef __cplusplus
extern "C" {
#endif

#include "utils.h"

/** @addtogroup ES32FXXX_ALD
  * @{
  */

/** @addtogroup CAN
  * @{
  */

/** @defgroup CAN_Public_Types CAN Public Types
  * @{
  */
/**
  * @brief  ALD State structures definition
  */
typedef enum {
	CAN_STATE_RESET           = 0x00U,	/**< CAN not yet initialized or disabled */
	CAN_STATE_READY           = 0x01U,	/**< CAN initialized and ready for use */
	CAN_STATE_BUSY            = 0x02U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_TX         = 0x11U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_RX0        = 0x21U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_RX1        = 0x41U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_TX_RX0     = 0x31U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_TX_RX1     = 0x51U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_RX0_RX1    = 0x61U,	/**< CAN process is ongoing */
	CAN_STATE_BUSY_TX_RX0_RX1 = 0x71U,	/**< CAN process is ongoing */
	CAN_STATE_TIMEOUT         = 0x04U,	/**< CAN in Timeout state */
	CAN_STATE_ERROR           = 0x08U,	/**< CAN error state */
} can_state_t;

/**
  * @brief CAN Error Code
  */
typedef enum {
	CAN_ERROR_NONE = 0x00U,		/**< No error */
	CAN_ERROR_EWG  = 0x01U,		/**< EWG error */
	CAN_ERROR_EPV  = 0x02U,		/**< EPV error */
	CAN_ERROR_BOF  = 0x04U,		/**< BOF error */
	CAN_ERROR_STF  = 0x08U,		/**< Stuff error */
	CAN_ERROR_FOR  = 0x10U,		/**< Form error */
	CAN_ERROR_ACK  = 0x20U,		/**< Acknowledgment error */
	CAN_ERROR_BR   = 0x40U,		/**< Bit recessive */
	CAN_ERROR_BD   = 0x80U,		/**< LEC dominant */
	CAN_ERROR_CRC  = 0x100U,	/**< LEC transfer error */
	CAN_ERROR_UNK  = 0x200U,	/**< Unknown error */
} can_error_t;

/**
  * @brief CAN Operating Mode
  */
 typedef enum {
	CAN_MODE_NORMAL          =  0x00U,	/**< Normal mode */
	CAN_MODE_LOOPBACK        =  0x01U,	/**< Loopback mode */
	CAN_MODE_SILENT          =  0x02U,	/**< Silent mode */
	CAN_MODE_SILENT_LOOPBACK =  0x03U,  	/**< Loopback combined with silent mode */
} can_operate_mode_t;

/**
  * @brief CAN Synchronization Jump Width
  */
typedef enum {
	CAN_SJW_1 = 0x0U,	/**< 1 time quantum */
	CAN_SJW_2 = 0x1U,	/**< 2 time quantum */
	CAN_SJW_3 = 0x2U,	/**< 3 time quantum */
	CAN_SJW_4 = 0x3U,	/**< 4 time quantum */
} can_sjw_t;

/**
  * @brief CAN Time Quantum in Bit Segment 1
  */
typedef enum {
	CAN_SEG1_1  = 0x0U,	/**< 1 time quantum */
	CAN_SEG1_2  = 0x1U,	/**< 2 time quantum */
	CAN_SEG1_3  = 0x2U,	/**< 3 time quantum */
	CAN_SEG1_4  = 0x3U,	/**< 4 time quantum */
	CAN_SEG1_5  = 0x4U,	/**< 5 time quantum */
	CAN_SEG1_6  = 0x5U,	/**< 6 time quantum */
	CAN_SEG1_7  = 0x6U,	/**< 7 time quantum */
	CAN_SEG1_8  = 0x7U,	/**< 8 time quantum */
	CAN_SEG1_9  = 0x8U,	/**< 9 time quantum */
	CAN_SEG1_10 = 0x9U,	/**< 10 time quantum */
	CAN_SEG1_11 = 0xAU,	/**< 11 time quantum */
	CAN_SEG1_12 = 0xBU,	/**< 12 time quantum */
	CAN_SEG1_13 = 0xCU,	/**< 13 time quantum */
	CAN_SEG1_14 = 0xDU,	/**< 14 time quantum */
	CAN_SEG1_15 = 0xEU,	/**< 15 time quantum */
	CAN_SEG1_16 = 0xFU,	/**< 16 time quantum */
} can_seg1_t;

/**
  * @brief CAN Time Quantum in Bit Segment 2
  */
typedef enum {
	CAN_SEG2_1 = 0x0U,	/**< 1 time quantum */
	CAN_SEG2_2 = 0x1U,     	/**< 2 time quantum */
	CAN_SEG2_3 = 0x2U,     	/**< 3 time quantum */
	CAN_SEG2_4 = 0x3U,     	/**< 4 time quantum */
	CAN_SEG2_5 = 0x4U,     	/**< 5 time quantum */
	CAN_SEG2_6 = 0x5U,     	/**< 6 time quantum */
	CAN_SEG2_7 = 0x6U,     	/**< 7 time quantum */
	CAN_SEG2_8 = 0x7U,     	/**< 8 time quantum */
} can_seg2_t;

/**
  * @brief CAN Filter Mode
  */
typedef enum {
	CAN_FILTER_MODE_MASK = 0x0U,	/**< Identifier mask mode */
	CAN_FILTER_MODE_LIST = 0x1U,	/**< Identifier list mode */
} can_filter_mode_t;

/**
  * @brief CAN Filter Scale
  */
typedef enum {
	CAN_FILTER_SCALE_16 = 0x0U,	/**< Two 16-bit filters */
	CAN_FILTER_SCALE_32 = 0x1U,	/**< One 32-bit filter */
} can_filter_scale_t;

/**
  * @brief CAN Filter fifo
  */
typedef enum {
	CAN_FILTER_FIFO0 = 0x0U,	/**< FIFO 0 assignment for filter */
	CAN_FILTER_FIFO1 = 0x1U,	/**< FIFO 1 assignment for filter */
} can_filter_fifo_t;

/**
  * @brief CAN Identifier Type
  */
typedef enum {
	CAN_ID_STD = 0x0U,	/**< Standard Id */
	CAN_ID_EXT = 0x1U,	/**< Extended Id */
} can_id_type_t;

/**
  * @brief CAN Remote Transmission Request
  */
typedef enum {
	CAN_RTR_DATA   = 0x0U,	/**< Data frame */
	CAN_RTR_REMOTE = 0x1U, 	/**< Remote frame */
} can_remote_req_t;

/**
  * @brief CAN Transmit Constants
  */
typedef enum {
	CAN_TX_MAILBOX_0    = 0x0U,	/**< TX mailbox index 0 */
	CAN_TX_MAILBOX_1    = 0x1U,	/**< TX mailbox index 1 */
	CAN_TX_MAILBOX_2    = 0x2U,	/**< TX mailbox index 2 */
	CAN_TX_MAILBOX_NONE = 0x3U,	/**< MailBox can't be used */
} can_tx_mailbox_t;

/**
  * @brief  CAN Receive fifo Number
  */
typedef enum {
	CAN_RX_FIFO0 = 0x0U,	/**< CAN fifo 0 used to receive */
	CAN_RX_FIFO1 = 0x1U,	/**< CAN fifo 1 used to receive */
} can_rx_fifo_t;

/**
  * @brief  CAN Flags
  */
typedef enum {
	CAN_FLAG_SLPS   = (1U << 1),			/**< Sleep acknowledge flag */
	CAN_FLAG_ERR    = (1U << 2),			/**< Error flag*/
	CAN_FLAG_WK     = (1U << 3),			/**< Wake up flag */
	CAN_FLAG_SLP    = (1U << 4),			/**< Sleep acknowledge flag */
	CAN_FLAG_M0REQC = (1U << 20) | (1U << 0),	/**< Request MailBox0 flag */
	CAN_FLAG_M0TXC  = (1U << 20) | (1U << 1),	/**< Transmission OK MailBox0 flag */
	CAN_FLAG_M1REQC = (1U << 20) | (1U << 8),	/**< Request MailBox1 flag */
	CAN_FLAG_M1TXC  = (1U << 20) | (1U << 9),	/**< Transmission OK MailBox1 flag */
	CAN_FLAG_M2REQC = (1U << 20) | (1U << 16),	/**< Request MailBox2 flag */
	CAN_FLAG_M2TXC  = (1U << 20) | (1U << 17),	/**< Transmission OK MailBox2 flag */
	CAN_FLAG_TXM0   = (1U << 20) | (1U << 26),	/**< Transmit mailbox 0 empty flag */
	CAN_FLAG_TXM1   = (1U << 20) | (1U << 27),	/**< Transmit mailbox 1 empty flag */
	CAN_FLAG_TXM2   = (1U << 20) | (1U << 28),	/**< Transmit mailbox 2 empty flag */
	CAN_FLAG_FF0    = (2U << 20) | (1U << 3),	/**< FIFO 0 Full flag */
	CAN_FLAG_FOV0   = (2U << 20) | (1U << 4),	/**< FIFO 0 Overrun flag */
	CAN_FLAG_FF1    = (3U << 20) | (1U << 3),	/**< FIFO 1 Full flag */
	CAN_FLAG_FOV1   = (3U << 20) | (1U << 4),	/**< FIFO 1 Overrun flag */
	CAN_FLAG_WARN   = (4U << 20) | (1U << 0),	/**< Error warning flag */
	CAN_FLAG_PERR   = (4U << 20) | (1U << 1),	/**< Error passive flag */
	CAN_FLAG_BOF    = (4U << 20) | (1U << 2),	/**< Bus-Off flag */
} can_flag_t;

/**
  * @brief CAN Interrupts
  */
typedef enum {
	CAN_IT_TXM   = (1U << 0),	/**< Transmit mailbox empty interrupt bit */
	CAN_IT_FP0   = (1U << 1),	/**< FIFO0 message pending interrupt bit */
	CAN_IT_FF0   = (1U << 2),	/**< FIFO0 full interrupt bit */
	CAN_IT_FOV0  = (1U << 3),	/**< FIFO0 overrun interrupt bit */
	CAN_IT_FP1   = (1U << 4),	/**< FIFO1 message pending interrupt bit */
	CAN_IT_FF1   = (1U << 5),	/**< FIFO1 full interrupt bit */
	CAN_IT_FOV1  = (1U << 6),	/**< FIFO1 overrun interrupt bit */
	CAN_IT_WARN  = (1U << 8),	/**< Error warning interrupt bit */
	CAN_IT_PERR  = (1U << 9),	/**< Error passive interrupt bit */
	CAN_IT_BOF   = (1U << 10),	/**< Bus-off interrupt bit */
	CAN_IT_PRERR = (1U << 11),	/**< Last error code interrupt bit */
	CAN_IT_ERR   = (1U << 15),	/**< Error interrupt bit */
	CAN_IT_WK    = (1U << 16),	/**< wake-up interrupt bit */
	CAN_IT_SLP   = (1U << 17),	/**< sleep interrupt bit */
} can_it_t;

/**
  * @brief CAN filter configuration structure definition
  */
typedef struct {
	uint32_t id_high;		/**< Specifies the filter identification number */
	uint32_t id_low;		/**< Specifies the filter identification number */
	uint32_t mask_id_high;		/**< Specifies the filter mask number or identification number */
	uint32_t mask_id_low;		/**< Specifies the filter mask number or identification number */
	can_filter_fifo_t fifo;		/**< Specifies the fifo (0 or 1) which will be assigned to the filter. */
	uint32_t number;		/**< Specifies the filter which will be initialized. */
	can_filter_mode_t mode;		/**< Specifies the filter mode to be initialized. */
	can_filter_scale_t scale;	/**< Specifies the filter scale. */
	type_func_t active;		/**< Enable or disable the filter. */
} can_filter_t;

/**
  * @brief CAN init structure definition
  */
typedef struct {
	uint32_t psc;			/**< Specifies the length of a time quantum. */
	can_operate_mode_t mode;	/**< Specifies the CAN operating mode. */
	can_sjw_t sjw;			/**< Specifies the maximum number of time quanta the CAN hardware is
	                                       allowed to lengthen or shorten a bit to perform resynchronization. */
	can_seg1_t seg1;		/**< Specifies the number of time quanta in Bit Segment 1. */
	can_seg2_t seg2;		/**< Specifies the number of time quanta in Bit Segment 2. */
	type_func_t ttcm;		/**< Enable or disable the time triggered communication mode. */
	type_func_t abom;		/**< Enable or disable the automatic bus-off management. */
	type_func_t awk;		/**< Enable or disable the automatic wake-up mode. */
	type_func_t artx;		/**< Enable or disable the non-automatic retransmission mode. */
	type_func_t rfom;		/**< Enable or disable the Receive fifo Locked mode. */
	type_func_t txmp;		/**< Enable or disable the transmit fifo priority. */
} can_init_t;

/**
  * @brief CAN Tx message structure definition
  */
typedef struct {
	uint32_t std;		/**< Specifies the standard identifier. */
	uint32_t ext;		/**< Specifies the extended identifier. */
	can_id_type_t type;	/**< Specifies the type of identifier for the message that will be transmitted. */
	can_remote_req_t rtr;	/**< Specifies the type of frame for the message that will be transmitted. */
	uint32_t len;		/**< Specifies the length of the frame that will be transmitted. */
	uint8_t data[8];	/**< Contains the data to be transmitted. */
} can_tx_msg_t;

/**
  * @brief CAN Rx message structure definition
  */
typedef struct {
	uint32_t std;		/**< Specifies the standard identifier. */
	uint32_t ext;		/**< Specifies the extended identifier. */
	can_id_type_t type;	/**< Specifies the type of identifier for the message that will be received. */
	can_remote_req_t rtr;	/**< Specifies the type of frame for the received message. */
	uint32_t len;		/**< Specifies the length of the frame that will be received. */
	uint8_t data[8];	/**< Contains the data to be received. */
	uint32_t fmi;		/**< Specifies the index of the filter the message stored in the mailbox passes through. */
	can_rx_fifo_t num;	/**< Specifies the receive fifo number. */
} can_rx_msg_t;

/**
  * @brief CAN handle Structure definition
  */
typedef struct can_handle_s {
	CAN_TypeDef *perh;	/**< Register base address */
	can_init_t init;	/**< CAN required parameters */
	can_rx_msg_t *rx0_msg;	/**< Pointer to receive message from FIFO0 */
	can_rx_msg_t *rx1_msg;	/**< Pointer to receive message from FIFO1 */
	lock_state_t lock;	/**< CAN locking object */
	can_state_t state;	/**< CAN communication state */
	can_error_t err;	/**< CAN Error code */

	void (*tx_cplt_cbk)(struct can_handle_s *arg);				/**< Tx completed callback */
	void (*rx_cplt_cbk)(struct can_handle_s *arg, can_rx_fifo_t num);	/**< Rx completed callback */
	void (*error_cbk)(struct can_handle_s *arg);				/**< error callback */
} can_handle_t;
/**
  * @}
  */

/** @defgroup CAN_Public_Macro CAN Public Macros
  * @{
  */
#define CAN_RESET_HANDLE_STATE(x)	((x)->state = CAN_STATE_RESET)
#define CAN_RX_MSG_PENDING(x, y)	(((y) == CAN_RX_FIFO0) ? \
	(READ_BIT((x)->perh->RXF0, CAN_RXF0_PEND_MSK)) : (READ_BIT((x)->perh->RXF1, CAN_RXF1_PEND_MSK)))
#define CAN_DBG_FREEZE(x, y)	(MODIFY_REG((x)->perh->CON, CAN_CON_DBGSTP_MSK, (y) << CAN_CON_DBGSTP_POS))
#define CAN_TX_STAMP_ENABLE(x, y)	(SET_BIT((x)->perh->TxMailBox[(y)].TXFCON, CAN_TXFCON0_TXGT_MSK))
#define CAN_TX_STAMP_DISABLE(x, y)	(CLEAR_BIT((x)->perh->TxMailBox[(y)].TXFCON, CAN_TXFCON0_TXGT_MSK))
/**
  * @}
  */

/** @defgroup CAN_Private_Macros CAN Private Macros
  * @{
  */
#define IS_CAN_ALL(x)	((x) == CAN0)
#define IS_CAN_FILTER_NUMBER(x) ((x) <= 13)
#define IS_CAN_MODE(x)	(((x) == CAN_MODE_NORMAL)   || \
                         ((x) == CAN_MODE_LOOPBACK) || \
                         ((x) == CAN_MODE_SILENT)   || \
                         ((x) == CAN_MODE_SILENT_LOOPBACK))
#define IS_CAN_SJW(x)	(((x) == CAN_SJW_1) || \
                         ((x) == CAN_SJW_2) || \
                         ((x) == CAN_SJW_3) || \
                         ((x) == CAN_SJW_4))
#define IS_CAN_BS1(x)	((x) <= CAN_SEG1_16)
#define IS_CAN_BS2(x)	((x) <= CAN_SEG2_8)
#define IS_CAN_FILTER_MODE(x)	(((x) == CAN_FILTER_MODE_MASK) || \
                                 ((x) == CAN_FILTER_MODE_LIST))
#define IS_CAN_FILTER_SCALE(x)	(((x) == CAN_FILTER_SCALE_16) || \
                                 ((x) == CAN_FILTER_SCALE_32))
#define IS_CAN_FILTER_FIFO(x)	(((x) == CAN_FILTER_FIFO0) || \
                                 ((x) == CAN_FILTER_FIFO1))
#define IS_CAN_IDTYPE(x)	(((x) == CAN_ID_STD) || \
                                 ((x) == CAN_ID_EXT))
#define IS_CAN_RTR(x)	(((x) == CAN_RTR_DATA) || ((x) == CAN_RTR_REMOTE))
#define IS_CAN_FIFO(x)	(((x) == CAN_RX_FIFO0) || ((x) == CAN_RX_FIFO1))
#define IS_CAN_TX_MAILBOX(x)	((x) <= CAN_TX_MAILBOX_NONE)
#define IS_CAN_STDID(x)		((x) <= ((uint32_t)0x7FF))
#define IS_CAN_EXTID(x)		((x) <= ((uint32_t)0x1FFFFFFF))
#define IS_CAN_DATA_LEN(x)	((x) <= ((uint8_t)0x08))
#define IS_CAN_PRESCALER(x)	(((x) >= 1) && ((x) <= 1024))
#define IS_CAN_GET_FLAG(x)	(((x)  == CAN_FLAG_SLPS)   || \
                                  ((x) == CAN_FLAG_ERR)    || \
                                  ((x) == CAN_FLAG_WK)     || \
                                  ((x) == CAN_FLAG_SLP)    || \
                                  ((x) == CAN_FLAG_M0REQC) || \
                                  ((x) == CAN_FLAG_M0TXC)  || \
                                  ((x) == CAN_FLAG_M1REQC) || \
                                  ((x) == CAN_FLAG_M1TXC)  || \
                                  ((x) == CAN_FLAG_M2REQC) || \
                                  ((x) == CAN_FLAG_M2TXC)  || \
                                  ((x) == CAN_FLAG_TXM0)   || \
                                  ((x) == CAN_FLAG_TXM1)   || \
                                  ((x) == CAN_FLAG_TXM2)   || \
                                  ((x) == CAN_FLAG_FF0)    || \
                                  ((x) == CAN_FLAG_FOV0)   || \
                                  ((x) == CAN_FLAG_FF1)    || \
                                  ((x) == CAN_FLAG_FOV1)   || \
                                  ((x) == CAN_FLAG_WARN)   || \
                                  ((x) == CAN_FLAG_PERR)   || \
                                  ((x) == CAN_FLAG_BOF))
#define IS_CAN_CLEAR_FLAG(x)	(((x)  == CAN_FLAG_ERR)    || \
                                  ((x) == CAN_FLAG_WK)     || \
                                  ((x) == CAN_FLAG_SLP)    || \
                                  ((x) == CAN_FLAG_M0REQC) || \
                                  ((x) == CAN_FLAG_M1REQC) || \
                                  ((x) == CAN_FLAG_M2REQC) || \
                                  ((x) == CAN_FLAG_FF0)    || \
                                  ((x) == CAN_FLAG_FOV0)   || \
                                  ((x) == CAN_FLAG_FF1)    || \
                                  ((x) == CAN_FLAG_FOV1))
#define IS_CAN_IT(x)		(((x)  == CAN_IT_TXM)   || \
                                  ((x) == CAN_IT_FP0) || \
                                  ((x) == CAN_IT_FF0) || \
                                  ((x) == CAN_IT_FOV0) || \
                                  ((x) == CAN_IT_FP1) || \
                                  ((x) == CAN_IT_FF1)   || \
                                  ((x) == CAN_IT_FOV1)  || \
                                  ((x) == CAN_IT_WARN)   || \
				  ((x) == CAN_IT_PERR) || \
                                  ((x) == CAN_IT_BOF) || \
                                  ((x) == CAN_IT_PRERR) || \
                                  ((x) == CAN_IT_ERR)   || \
                                  ((x) == CAN_IT_WK)  || \
                                  ((x) == CAN_IT_SLP))
#define CAN_TIMEOUT_VALUE	100
#define CAN_STATE_TX_MASK	(1U << 4)
#define CAN_STATE_RX0_MASK	(1U << 5)
#define CAN_STATE_RX1_MASK	(1U << 6)

/**
  * @}
  */

/** @addtogroup CAN_Public_Functions
  * @{
  */

/** @addtogroup CAN_Public_Functions_Group1
  *  @{
  */
/* Initialization functions */
void ald_can_reset(can_handle_t *hperh);
ald_status_t ald_can_init(can_handle_t *hperh);
ald_status_t ald_can_filter_config(can_handle_t *hperh, can_filter_t *config);
/**
  * @}
  */

/** @addtogroup CAN_Public_Functions_Group2
  * @{
  */
/* IO operation functions */
ald_status_t ald_can_send(can_handle_t *hperh, can_tx_msg_t *msg, uint32_t timeout);
ald_status_t ald_can_send_by_it(can_handle_t *hperh, can_tx_msg_t *msg);
ald_status_t ald_can_recv(can_handle_t *hperh, can_rx_fifo_t num, can_rx_msg_t *msg, uint32_t timeout);
ald_status_t ald_can_recv_by_it(can_handle_t *hperh, can_rx_fifo_t num, can_rx_msg_t *msg);
/**
  * @}
  */

/** @addtogroup CAN_Public_Functions_Group3
  * @{
  */
/* Control function */
ald_status_t ald_can_sleep(can_handle_t *hperh);
ald_status_t ald_can_wake_up(can_handle_t *hperh);
void ald_can_cancel_send(can_handle_t *hperh, can_tx_mailbox_t box);
void ald_can_irq_handler(can_handle_t *hperh);
type_bool_t ald_can_get_tx_status(can_handle_t *hperh, can_tx_mailbox_t box);
void ald_can_interrupt_config(can_handle_t *hperh, can_it_t it, type_func_t state);
it_status_t ald_can_get_it_status(can_handle_t *hperh, can_it_t it);
flag_status_t ald_can_get_flag_status(can_handle_t *hperh, can_flag_t flag);
void ald_can_clear_flag_status(can_handle_t *hperh, can_flag_t flag);
/**
  * @}
  */

/** @addtogroup CAN_Public_Functions_Group4
  * @{
  */
/* State and Error functions */
can_state_t ald_can_get_state(can_handle_t *hperh);
can_error_t ald_can_get_error(can_handle_t *hperh);
/**
  * @}
  */

/**
  * @}
  */

/**
  * @}
  */

/**
  * @}
  */

#ifdef __cplusplus
}
#endif

#endif /* __ALD_CAN_H */