VSF Documented
vsf_template_i2c.h
Go to the documentation of this file.
1/*****************************************************************************
2 * Copyright(C)2009-2022 by VSF Team *
3 * *
4 * Licensed under the Apache License, Version 2.0 (the "License"); *
5 * you may not use this file except in compliance with the License. *
6 * You may obtain a copy of the License at *
7 * *
8 * http://www.apache.org/licenses/LICENSE-2.0 *
9 * *
10 * Unless required by applicable law or agreed to in writing, software *
11 * distributed under the License is distributed on an "AS IS" BASIS, *
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
13 * See the License for the specific language governing permissions and *
14 * limitations under the License. *
15 * *
16 ****************************************************************************/
17
18#ifndef __VSF_TEMPLATE_I2C_H__
19#define __VSF_TEMPLATE_I2C_H__
20
21/*============================ INCLUDES ======================================*/
22
23#include "./vsf_template_hal_driver.h"
24#include "hal/arch/vsf_arch.h"
25
26#ifdef __cplusplus
27extern "C" {
28#endif
29
30/*============================ MACROS ========================================*/
31
38#ifndef VSF_I2C_CFG_MULTI_CLASS
39# define VSF_I2C_CFG_MULTI_CLASS ENABLED
40#endif
41
50#if defined(VSF_HW_I2C_COUNT) && !defined(VSF_HW_I2C_MASK)
51# define VSF_HW_I2C_MASK VSF_HAL_COUNT_TO_MASK(VSF_HW_I2C_COUNT)
52#endif
53
62#if !defined(VSF_HW_I2C_COUNT) && defined(VSF_HW_I2C_MASK)
63# define VSF_HW_I2C_COUNT VSF_HAL_MASK_TO_COUNT(VSF_HW_I2C_MASK)
64#endif
65
76#ifndef VSF_I2C_CFG_PREFIX
77# if VSF_I2C_CFG_MULTI_CLASS == ENABLED
78# define VSF_I2C_CFG_PREFIX vsf
79# elif defined(VSF_HW_I2C_COUNT) && (VSF_HW_I2C_COUNT != 0)
80# define VSF_I2C_CFG_PREFIX vsf_hw
81# else
82# define VSF_I2C_CFG_PREFIX vsf
83# endif
84#endif
85
94#ifndef VSF_I2C_CFG_FUNCTION_RENAME
95# define VSF_I2C_CFG_FUNCTION_RENAME ENABLED
96#endif
97
106#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_MODE
107# define VSF_I2C_CFG_REIMPLEMENT_TYPE_MODE DISABLED
108#endif
109
118#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_CMD
119# define VSF_I2C_CFG_REIMPLEMENT_TYPE_CMD DISABLED
120#endif
121
130#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK
131# define VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK DISABLED
132#endif
133
144#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS
145# define VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS DISABLED
146#endif
147
158#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL
159# define VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL DISABLED
160#endif
161
173#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_CFG
174# define VSF_I2C_CFG_REIMPLEMENT_TYPE_CFG DISABLED
175#endif
176
186#ifndef VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY
187# define VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY DISABLED
188#endif
189
198#ifndef VSF_I2C_CFG_INHERIT_HAL_CAPABILITY
199# define VSF_I2C_CFG_INHERIT_HAL_CAPABILITY ENABLED
200#endif
201
202/*============================ MACROFIED FUNCTIONS ===========================*/
203
210#define VSF_I2C_APIS(__prefix_name) \
211 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, i2c, init, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr) \
212 __VSF_HAL_TEMPLATE_API(__prefix_name, void, i2c, fini, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
213 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, i2c, get_configuration, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr) \
214 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, i2c, enable, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
215 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, i2c, disable, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
216 __VSF_HAL_TEMPLATE_API(__prefix_name, void, i2c, irq_enable, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, vsf_i2c_irq_mask_t irq_mask) \
217 __VSF_HAL_TEMPLATE_API(__prefix_name, void, i2c, irq_disable, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, vsf_i2c_irq_mask_t irq_mask) \
218 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_i2c_status_t, i2c, status, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
219 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_i2c_capability_t, i2c, capability, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
220 __VSF_HAL_TEMPLATE_API(__prefix_name, fsm_rt_t, i2c, master_fifo_transfer, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, uint16_t address, \
221 vsf_i2c_cmd_t cmd, uint_fast16_t count, uint8_t* buffer_ptr, vsf_i2c_cmd_t *cur_cmd_ptr, uint_fast16_t *offset_ptr) \
222 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, i2c, master_request, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, uint16_t address, \
223 vsf_i2c_cmd_t cmd, uint_fast16_t count, uint8_t* buffer_ptr) \
224 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, i2c, master_get_transferred_count, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
225 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, i2c, slave_fifo_transfer, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, bool transmit_or_receive, \
226 uint_fast16_t count, uint8_t* buffer_ptr) \
227 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, i2c, slave_request, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, bool transmit_or_receive, \
228 uint_fast16_t count, uint8_t* buffer_ptr) \
229 __VSF_HAL_TEMPLATE_API(__prefix_name, uint_fast16_t, i2c, slave_get_transferred_count, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr) \
230 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_err_t, i2c, ctrl, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, vsf_i2c_ctrl_t ctrl, void* param) \
231 __VSF_HAL_TEMPLATE_API(__prefix_name, vsf_i2c_irq_mask_t, i2c, irq_clear, VSF_MCONNECT(__prefix_name, _t) *i2c_ptr, vsf_i2c_irq_mask_t irq_mask)
232
233/*============================ TYPES =========================================*/
234
251#if VSF_I2C_CFG_REIMPLEMENT_TYPE_MODE == DISABLED
252typedef enum vsf_i2c_mode_t {
261 VSF_I2C_MODE_MASTER = (0x1ul << 28),
262
271 VSF_I2C_MODE_SLAVE = (0x0ul << 28),
272
281 VSF_I2C_SPEED_STANDARD_MODE = (0x0ul << 29),
282
291 VSF_I2C_SPEED_FAST_MODE = (0x1ul << 29),
292
301 VSF_I2C_SPEED_FAST_MODE_PLUS = (0x2ul << 29),
302
311 VSF_I2C_SPEED_HIGH_SPEED_MODE = (0x3ul << 29),
312
321 VSF_I2C_ADDR_7_BITS = (0x0ul << 31),
322
331 VSF_I2C_ADDR_10_BITS = (0x1ul << 31),
332} vsf_i2c_mode_t;
333#endif
334
343enum {
352 VSF_I2C_MODE_MASK = VSF_I2C_MODE_MASTER |
353 VSF_I2C_MODE_SLAVE,
354
363 VSF_I2C_SPEED_MASK = VSF_I2C_SPEED_STANDARD_MODE |
364 VSF_I2C_SPEED_FAST_MODE |
365 VSF_I2C_SPEED_FAST_MODE_PLUS |
366 VSF_I2C_SPEED_HIGH_SPEED_MODE,
367
376 VSF_I2C_ADDR_MASK = VSF_I2C_ADDR_7_BITS |
377 VSF_I2C_ADDR_10_BITS,
378
387 VSF_I2C_MODE_ALL_BITS_MASK = VSF_I2C_MODE_MASK |
388 VSF_I2C_SPEED_MASK |
389 VSF_I2C_ADDR_MASK,
390};
391
398#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CMD == DISABLED
399typedef enum vsf_i2c_cmd_t {
408 VSF_I2C_CMD_WRITE = (0x00ul << 0),
409
418 VSF_I2C_CMD_READ = (0x01ul << 0),
419
428 VSF_I2C_CMD_START = (0x01ul << 28),
429
438 VSF_I2C_CMD_STOP = (0x01ul << 29),
439
450 VSF_I2C_CMD_RESTART = (0x01ul << 30),
451
464 VSF_I2C_CMD_NO_START = (0x00ul << 28),
465
478 VSF_I2C_CMD_NO_STOP = (0x00ul << 29),
479
492 VSF_I2C_CMD_NO_RESTART = (0x00ul << 30),
493
502 VSF_I2C_CMD_7_BITS = (0x00ul << 31),
503
512 VSF_I2C_CMD_10_BITS = (0x01ul << 31),
513} vsf_i2c_cmd_t;
514#endif
515
524enum {
533 VSF_I2C_CMD_RW_MASK = VSF_I2C_CMD_WRITE | VSF_I2C_CMD_READ,
534
543 VSF_I2C_CMD_BITS_MASK = VSF_I2C_CMD_7_BITS |
544 VSF_I2C_CMD_10_BITS,
545
554#ifndef VSF_I2C_CMD_ALL_BITS_MASK
555 VSF_I2C_CMD_ALL_BITS_MASK = VSF_I2C_CMD_RW_MASK
556 | VSF_I2C_CMD_START
557 | VSF_I2C_CMD_STOP
558 | VSF_I2C_CMD_RESTART
559 | VSF_I2C_CMD_NO_START
560 | VSF_I2C_CMD_NO_STOP
561 | VSF_I2C_CMD_NO_RESTART
562 | VSF_I2C_CMD_BITS_MASK,
563#endif
564};
565
596#if VSF_I2C_CFG_REIMPLEMENT_TYPE_IRQ_MASK == DISABLED
597typedef enum vsf_i2c_irq_mask_t {
610 VSF_I2C_IRQ_MASK_MASTER_TX = (0x1ul << 0),
611
624 VSF_I2C_IRQ_MASK_MASTER_RX = (0x1ul << 1),
625
636 VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE = (0x1ul << 2),
637
648 VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST = (0x1ul << 3),
649
660 VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK = (0x1ul << 4),
661
672 VSF_I2C_IRQ_MASK_MASTER_TX_NACK_DETECT = (0x1ul << 5),
673
674
685 VSF_I2C_IRQ_MASK_MASTER_START_OR_RESTART_DETECT = (0x1ul << 6),
686
687
698 VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT = (0x1ul << 7),
699
700
711 VSF_I2C_IRQ_MASK_SLAVE_START_OR_RESTART_DETECT = (0x1ul << 8),
712
723 VSF_I2C_IRQ_MASK_SLAVE_STOP_DETECT = (0x1ul << 9),
724
737 VSF_I2C_IRQ_MASK_SLAVE_TX = (0x1ul << 10),
738
751 VSF_I2C_IRQ_MASK_SLAVE_RX = (0x1ul << 11),
752
763 VSF_I2C_IRQ_MASK_SLAVE_TRANSFER_COMPLETE = (0x1ul << 12),
764} vsf_i2c_irq_mask_t;
765#endif
766
767enum {
782#ifndef VSF_I2C_IRQ_MASK_MASTER_ERR
783 VSF_I2C_IRQ_MASK_MASTER_ERR = VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST
784 | VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK
785 | VSF_I2C_IRQ_MASK_MASTER_TX_NACK_DETECT,
786#endif
787
796#ifndef VSF_I2C_IRQ_MASK_SLAVE_ERR
797 VSF_I2C_IRQ_MASK_SLAVE_ERR = 0,
798#endif
799
808#ifndef VSF_I2C_IRQ_MASK_ERR
809 VSF_I2C_IRQ_MASK_ERR = VSF_I2C_IRQ_MASK_MASTER_ERR
810 | VSF_I2C_IRQ_MASK_SLAVE_ERR,
811#endif
812
813#ifndef VSF_I2C_IRQ_ALL_BITS_MASK
814 VSF_I2C_IRQ_ALL_BITS_MASK = VSF_I2C_IRQ_MASK_MASTER_TX
815 | VSF_I2C_IRQ_MASK_MASTER_RX
816 | VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE
817 | VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST
818 | VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK
819 | VSF_I2C_IRQ_MASK_MASTER_TX_NACK_DETECT
820 | VSF_I2C_IRQ_MASK_MASTER_START_OR_RESTART_DETECT
821 | VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT
822 | VSF_I2C_IRQ_MASK_SLAVE_START_OR_RESTART_DETECT
823 | VSF_I2C_IRQ_MASK_SLAVE_STOP_DETECT
824 | VSF_I2C_IRQ_MASK_SLAVE_TX
825 | VSF_I2C_IRQ_MASK_SLAVE_RX
826 | VSF_I2C_IRQ_MASK_SLAVE_TRANSFER_COMPLETE,
827#endif
828};
829
830#if VSF_I2C_CFG_REIMPLEMENT_TYPE_STATUS == DISABLED
837typedef struct vsf_i2c_status_t {
838 union {
839 inherit(vsf_peripheral_status_t)
840 struct {
841 uint32_t is_busy : 1;
842 };
843 uint32_t value;
844 };
845} vsf_i2c_status_t;
846#endif
847
848#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CAPABILITY == DISABLED
857typedef struct vsf_i2c_capability_t {
858#if VSF_I2C_CFG_INHERIT_HAL_CAPABILITY == ENABLED
859 inherit(vsf_peripheral_capability_t)
860#endif
863 vsf_i2c_irq_mask_t irq_mask;
864
867 uint8_t support_no_start : 1;
868
871 uint8_t support_no_stop : 1;
872
875 uint8_t support_restart : 1;
876
879 uint_fast16_t max_transfer_size;
880
883 uint_fast16_t min_transfer_size;
884} vsf_i2c_capability_t;
885#endif
886
887#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CFG == DISABLED
894typedef struct vsf_i2c_t vsf_i2c_t;
895
929typedef void vsf_i2c_isr_handler_t(void *target_ptr,
930 vsf_i2c_t *i2c_ptr,
931 vsf_i2c_irq_mask_t irq_mask);
932
940typedef struct vsf_i2c_isr_t {
943 vsf_i2c_isr_handler_t *handler_fn;
944
947 void *target_ptr;
948
951 vsf_arch_prio_t prio;
952} vsf_i2c_isr_t;
953
961typedef struct vsf_i2c_cfg_t {
964 vsf_i2c_mode_t mode;
965
968 uint32_t clock_hz;
969
972 vsf_i2c_isr_t isr;
973
976 uint_fast16_t slave_addr;
977} vsf_i2c_cfg_t;
978#endif
979
980#if VSF_I2C_CFG_REIMPLEMENT_TYPE_CTRL == DISABLED
989typedef enum vsf_i2c_ctrl_t {
990 /*
993 VSF_I2C_CTRL_MASTER_ABORT = (0x1ul << 3),
994 #define VSF_I2C_CTRL_MASTER_ABORT VSF_I2C_CTRL_MASTER_ABORT
995 */
996
997 /*
1000 VSF_I2C_CTRL_SLAVE_ABORT = (0x1ul << 4),
1001 #define VSF_I2C_CTRL_SLAVE_ABORT VSF_I2C_CTRL_SLAVE_ABORT
1002 */
1003
1004 /*
1007 VSF_I2C_CTRL_ANALOG_FILTER_ENABLE = (0x0ul << 5),
1010 VSF_I2C_CTRL_ANALOG_FILTER_DISABLE = (0x1ul << 5),
1011 #define VSF_I2C_CTRL_ANALOG_FILTER_ENABLE VSF_I2C_CTRL_ANALOG_FILTER_ENABLE
1012 #define VSF_I2C_CTRL_ANALOG_FILTER_DISABLE VSF_I2C_CTRL_ANALOG_FILTER_DISABLE
1013 */
1014
1015 /*
1018 VSF_I2C_CTRL_DIGITAL_FILTER_ENABLE = (0x0ul << 7),
1021 VSF_I2C_CTRL_DIGITAL_FILTER_DISABLE = (0x1ul << 7),
1022 #define VSF_I2C_CTRL_DIGITAL_FILTER_ENABLE VSF_I2C_CTRL_DIGITAL_FILTER_ENABLE
1023 #define VSF_I2C_CTRL_DIGITAL_FILTER_DISABLE VSF_I2C_CTRL_DIGITAL_FILTER_DISABLE
1024 */
1025
1028 __VSF_I2C_CTRL_DUMMP = 0,
1029} vsf_i2c_ctrl_t;
1030#endif
1031
1040typedef struct vsf_i2c_op_t {
1042#undef __VSF_HAL_TEMPLATE_API
1043#define __VSF_HAL_TEMPLATE_API VSF_HAL_TEMPLATE_API_FP
1045
1046 VSF_I2C_APIS(vsf_i2c)
1047} vsf_i2c_op_t;
1048
1049#if VSF_I2C_CFG_MULTI_CLASS == ENABLED
1056struct vsf_i2c_t {
1059 const vsf_i2c_op_t * op;
1060};
1061#endif
1062
1063/*============================ GLOBAL VARIABLES ==============================*/
1064/*============================ PROTOTYPES ====================================*/
1065
1085extern vsf_err_t vsf_i2c_init(vsf_i2c_t *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr);
1086
1098extern void vsf_i2c_fini(vsf_i2c_t *i2c_ptr);
1099
1117extern vsf_err_t vsf_i2c_get_configuration(vsf_i2c_t *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr);
1118
1130extern fsm_rt_t vsf_i2c_enable(vsf_i2c_t *i2c_ptr);
1131
1146extern fsm_rt_t vsf_i2c_disable(vsf_i2c_t *i2c_ptr);
1147
1161extern void vsf_i2c_irq_enable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask);
1162
1176extern void vsf_i2c_irq_disable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask);
1177
1189extern vsf_i2c_status_t vsf_i2c_status(vsf_i2c_t *i2c_ptr);
1190
1202extern vsf_i2c_capability_t vsf_i2c_capability(vsf_i2c_t *i2c_ptr);
1203
1239extern fsm_rt_t vsf_i2c_master_fifo_transfer(vsf_i2c_t *i2c_ptr,
1240 uint16_t address,
1241 vsf_i2c_cmd_t cmd,
1242 uint_fast16_t count,
1243 uint8_t *buffer_ptr,
1244 vsf_i2c_cmd_t *cur_cmd_ptr,
1245 uint_fast16_t *offset_ptr);
1246
1266extern uint_fast16_t vsf_i2c_slave_fifo_transfer(vsf_i2c_t *i2c_ptr,
1267 bool transmit_or_receive,
1268 uint_fast16_t count,
1269 uint8_t *buffer_ptr);
1270
1290extern vsf_err_t vsf_i2c_master_request(vsf_i2c_t *i2c_ptr,
1291 uint16_t address,
1292 vsf_i2c_cmd_t cmd,
1293 uint_fast16_t count,
1294 uint8_t *buffer_ptr);
1295
1313extern vsf_err_t vsf_i2c_slave_request(vsf_i2c_t *i2c_ptr,
1314 bool transmit_or_receive,
1315 uint_fast16_t count,
1316 uint8_t *buffer_ptr);
1317
1331extern uint_fast16_t vsf_i2c_master_get_transferred_count(vsf_i2c_t *i2c_ptr);
1332
1344extern uint_fast16_t vsf_i2c_slave_get_transferred_count(vsf_i2c_t *i2c_ptr);
1345
1361extern vsf_err_t vsf_i2c_ctrl(vsf_i2c_t *i2c_ptr, vsf_i2c_ctrl_t ctrl, void * param);
1362
1393extern vsf_i2c_irq_mask_t vsf_i2c_irq_clear(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask);
1394
1395/*============================ INCLUDES ======================================*/
1396
1397#include "hal/driver/common/i2c/i2c_request.h"
1398
1399/*============================ MACROFIED FUNCTIONS ===========================*/
1400
1402#if VSF_I2C_CFG_FUNCTION_RENAME == ENABLED
1403# define __vsf_i2c_t VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_t)
1404# define vsf_i2c_init(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_init) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1405# define vsf_i2c_fini(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_fini) ((__vsf_i2c_t *)(__I2C))
1406# define vsf_i2c_get_configuration(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_get_configuration) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1407# define vsf_i2c_enable(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_enable) ((__vsf_i2c_t *)(__I2C))
1408# define vsf_i2c_disable(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_disable) ((__vsf_i2c_t *)(__I2C))
1409# define vsf_i2c_irq_enable(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_enable) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1410# define vsf_i2c_irq_disable(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_disable) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1411# define vsf_i2c_irq_clear(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_irq_clear) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1412# define vsf_i2c_status(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_status) ((__vsf_i2c_t *)(__I2C))
1413# define vsf_i2c_capability(__I2C) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_capability) ((__vsf_i2c_t *)(__I2C))
1414# define vsf_i2c_master_fifo_transfer(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_fifo_transfer) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1415# define vsf_i2c_master_request(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_request) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1416# define vsf_i2c_master_get_transferred_count(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_master_get_transferred_count) ((__vsf_i2c_t *)(__I2C))
1417# define vsf_i2c_slave_fifo_transfer(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_slave_fifo_transfer) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1418# define vsf_i2c_slave_request(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_slave_request) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1419# define vsf_i2c_slave_get_transferred_count(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_slave_get_transferred_count) ((__vsf_i2c_t *)(__I2C))
1420# define vsf_i2c_ctrl(__I2C, ...) VSF_MCONNECT(VSF_I2C_CFG_PREFIX, _i2c_ctrl) ((__vsf_i2c_t *)(__I2C), ##__VA_ARGS__)
1421#endif
1423
1424#ifdef __cplusplus
1425}
1426#endif
1427
1428#endif /*__VSF_TEMPLATE_I2C_H__*/
vsf_err_t
vsf_err_t
Definition __type.h:42
vsf_arch_prio_t
vsf_arch_prio_t
Definition cortex_a_generic.h:88
vsf_i2c_cmd_t
vsf_i2c_cmd_t
Definition i2c.h:32
vsf_i2c_irq_mask_t
vsf_i2c_irq_mask_t
Definition i2c.h:103
vsf_i2c_mode_t
vsf_i2c_mode_t
Definition i2c.h:116
vsf_i2c_irq_mask_t
vsf_i2c_irq_mask_t
Definition i2c.h:154
vsf_i2c_isr_handler_t
void vsf_i2c_isr_handler_t(void *target_ptr, vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask)
Definition i2c.h:197
i2c_request.h
irq_mask
const i_spi_t vsf_spi_irq_mask_t irq_mask
Definition spi_interface.h:38
uint16_t
unsigned short uint16_t
Definition stdint.h:7
uint32_t
unsigned uint32_t
Definition stdint.h:9
uint_fast16_t
unsigned short uint_fast16_t
Definition stdint.h:25
uint8_t
unsigned char uint8_t
Definition stdint.h:5
vsf_i2c_capability_t
Predefined I2C capability structure that can be reimplemented in specific HAL drivers.
Definition vsf_template_i2c.h:857
vsf_i2c_capability_t::support_restart
uint8_t support_restart
Definition vsf_template_i2c.h:875
vsf_i2c_capability_t::support_no_stop
uint8_t support_no_stop
Definition vsf_template_i2c.h:871
vsf_i2c_capability_t::inherit
inherit(vsf_peripheral_capability_t) vsf_i2c_irq_mask_t irq_mask
vsf_i2c_capability_t::max_transfer_size
uint_fast16_t max_transfer_size
Definition vsf_template_i2c.h:879
vsf_i2c_capability_t::min_transfer_size
uint_fast16_t min_transfer_size
Definition vsf_template_i2c.h:883
vsf_i2c_capability_t::support_no_start
uint8_t support_no_start
Definition vsf_template_i2c.h:867
vsf_i2c_cfg_t
I2C configuration.
Definition vsf_template_i2c.h:961
vsf_i2c_cfg_t::mode
vsf_i2c_mode_t mode
Definition vsf_template_i2c.h:964
vsf_i2c_cfg_t::slave_addr
uint_fast16_t slave_addr
Definition vsf_template_i2c.h:976
vsf_i2c_cfg_t::isr
vsf_i2c_isr_t isr
Definition vsf_template_i2c.h:972
vsf_i2c_cfg_t::clock_hz
uint32_t clock_hz
Definition vsf_template_i2c.h:968
vsf_i2c_isr_t
I2C interrupt configuration.
Definition vsf_template_i2c.h:940
vsf_i2c_isr_t::handler_fn
vsf_i2c_isr_handler_t * handler_fn
Definition vsf_template_i2c.h:943
vsf_i2c_isr_t::target_ptr
void * target_ptr
Definition vsf_template_i2c.h:947
vsf_i2c_isr_t::prio
vsf_arch_prio_t prio
Definition vsf_template_i2c.h:951
vsf_i2c_op_t
I2C operation function pointers for multi-class support.
Definition vsf_template_i2c.h:1040
vsf_i2c_status_t
Predefined VSF I2C status that can be reimplemented in specific hal drivers.
Definition vsf_template_i2c.h:837
vsf_i2c_status_t::value
uint32_t value
Definition vsf_template_i2c.h:843
vsf_i2c_t
I2C instance structure for multi-class support.
Definition vsf_template_i2c.h:1056
vsf_i2c_t::op
const vsf_i2c_op_t * op
Definition vsf_template_i2c.h:1059
vsf_peripheral_capability_t
Definition vsf_template_hal_driver.h:204
vsf_peripheral_status_t
Definition vsf_template_hal_driver.h:197
vsf_arch.h
fsm_rt_t
fsm_rt_t
Definition vsf_fsm.h:315
vsf_template_hal_driver.h
vsf_i2c_irq_disable
void vsf_i2c_irq_disable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask)
I2C instance disables interrupts.
Definition i2c_common.c:92
vsf_i2c_cfg_t
struct vsf_i2c_cfg_t vsf_i2c_cfg_t
I2C configuration.
vsf_i2c_status_t
struct vsf_i2c_status_t vsf_i2c_status_t
Predefined VSF I2C status that can be reimplemented in specific hal drivers.
vsf_i2c_disable
fsm_rt_t vsf_i2c_disable(vsf_i2c_t *i2c_ptr)
Disable a I2C instance.
Definition i2c_common.c:74
VSF_I2C_MODE_MASK
@ VSF_I2C_MODE_MASK
Mask for master/slave mode selection. Extracts VSF_I2C_MODE_MASTER and VSF_I2C_MODE_SLAVE bits.
Definition vsf_template_i2c.h:352
VSF_I2C_ADDR_MASK
@ VSF_I2C_ADDR_MASK
Mask for I2C address mode selection. Extracts VSF_I2C_ADDR_7_BITS and VSF_I2C_ADDR_10_BITS bits.
Definition vsf_template_i2c.h:376
VSF_I2C_MODE_ALL_BITS_MASK
@ VSF_I2C_MODE_ALL_BITS_MASK
Combined mask for all I2C mode configuration bits. Includes mode, speed, and address mode masks.
Definition vsf_template_i2c.h:387
VSF_I2C_SPEED_MASK
@ VSF_I2C_SPEED_MASK
Mask for I2C speed mode configuration. Extracts all speed mode bits (standard, fast,...
Definition vsf_template_i2c.h:363
vsf_i2c_slave_get_transferred_count
uint_fast16_t vsf_i2c_slave_get_transferred_count(vsf_i2c_t *i2c_ptr)
get the counter of transfers for current request by the I2C slave
Definition i2c_common.c:187
vsf_i2c_capability
vsf_i2c_capability_t vsf_i2c_capability(vsf_i2c_t *i2c_ptr)
Get the capabilities of I2C instance.
Definition i2c_common.c:119
vsf_i2c_mode_t
vsf_i2c_mode_t
Predefined VSF I2C modes that can be reimplemented in specific HAL drivers.If we want to add optional...
Definition vsf_template_i2c.h:252
VSF_I2C_MODE_MASTER
@ VSF_I2C_MODE_MASTER
Select master mode for I2C operation. The device initiates and controls the I2C bus communication.
Definition vsf_template_i2c.h:261
VSF_I2C_SPEED_HIGH_SPEED_MODE
@ VSF_I2C_SPEED_HIGH_SPEED_MODE
High speed mode, up to 3.4 Mbit/s. Highest specified I2C speed for performance-critical applications.
Definition vsf_template_i2c.h:311
VSF_I2C_MODE_SLAVE
@ VSF_I2C_MODE_SLAVE
Select slave mode for I2C operation. The device responds to I2C bus commands from master devices.
Definition vsf_template_i2c.h:271
VSF_I2C_SPEED_STANDARD_MODE
@ VSF_I2C_SPEED_STANDARD_MODE
Standard mode, up to 100 kbit/s. The lowest I2C speed specification, compatible with most devices.
Definition vsf_template_i2c.h:281
VSF_I2C_ADDR_7_BITS
@ VSF_I2C_ADDR_7_BITS
7-bit address mode. Standard addressing mode supporting up to 128 unique devices.
Definition vsf_template_i2c.h:321
VSF_I2C_SPEED_FAST_MODE_PLUS
@ VSF_I2C_SPEED_FAST_MODE_PLUS
Fast mode plus, up to 1 Mbit/s. Enhanced fast mode for higher throughput applications.
Definition vsf_template_i2c.h:301
VSF_I2C_SPEED_FAST_MODE
@ VSF_I2C_SPEED_FAST_MODE
Fast mode, up to 400 kbit/s. Commonly used medium speed I2C mode.
Definition vsf_template_i2c.h:291
VSF_I2C_ADDR_10_BITS
@ VSF_I2C_ADDR_10_BITS
10-bit address mode. Extended addressing mode supporting up to 1024 unique devices.
Definition vsf_template_i2c.h:331
vsf_i2c_ctrl
vsf_err_t vsf_i2c_ctrl(vsf_i2c_t *i2c_ptr, vsf_i2c_ctrl_t ctrl, void *param)
Calls the specified I2C command.
Definition i2c_common.c:196
VSF_I2C_CMD_RW_MASK
@ VSF_I2C_CMD_RW_MASK
Mask for read/write command selection. Extracts VSF_I2C_CMD_WRITE and VSF_I2C_CMD_READ bits.
Definition vsf_template_i2c.h:533
VSF_I2C_CMD_BITS_MASK
@ VSF_I2C_CMD_BITS_MASK
Mask for I2C address bits configuration. Extracts VSF_I2C_CMD_7_BITS and VSF_I2C_CMD_10_BITS bits.
Definition vsf_template_i2c.h:543
VSF_I2C_CMD_ALL_BITS_MASK
@ VSF_I2C_CMD_ALL_BITS_MASK
Combined mask for all I2C command bits. Includes read/write, start/stop/restart, no_start/no_stop/no_...
Definition vsf_template_i2c.h:555
vsf_i2c_capability_t
struct vsf_i2c_capability_t vsf_i2c_capability_t
Predefined I2C capability structure that can be reimplemented in specific HAL drivers.
vsf_i2c_isr_t
struct vsf_i2c_isr_t vsf_i2c_isr_t
I2C interrupt configuration.
vsf_i2c_status
vsf_i2c_status_t vsf_i2c_status(vsf_i2c_t *i2c_ptr)
Get the status of I2C instance.
Definition i2c_common.c:110
vsf_i2c_master_get_transferred_count
uint_fast16_t vsf_i2c_master_get_transferred_count(vsf_i2c_t *i2c_ptr)
get the counter of transfers for current request by the I2C master
Definition i2c_common.c:178
vsf_i2c_get_configuration
vsf_err_t vsf_i2c_get_configuration(vsf_i2c_t *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr)
Get current configuration of a I2C instance.
Definition i2c_common.c:55
vsf_i2c_irq_clear
vsf_i2c_irq_mask_t vsf_i2c_irq_clear(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask)
Clear interrupt flags of I2C instance and return previous state.
Definition i2c_common.c:101
vsf_i2c_init
vsf_err_t vsf_i2c_init(vsf_i2c_t *i2c_ptr, vsf_i2c_cfg_t *cfg_ptr)
Initialize a I2C instance.
Definition i2c_common.c:37
vsf_i2c_cmd_t
vsf_i2c_cmd_t
Predefined VSF I2C commands that can be reimplemented in specific HAL drivers.
Definition vsf_template_i2c.h:399
VSF_I2C_CMD_NO_STOP
@ VSF_I2C_CMD_NO_STOP
No stop condition command. Indicates that no STOP condition should be generated for this transfer....
Definition vsf_template_i2c.h:478
VSF_I2C_CMD_NO_RESTART
@ VSF_I2C_CMD_NO_RESTART
No restart condition command. Indicates that no RESTART condition should be generated for this transf...
Definition vsf_template_i2c.h:492
VSF_I2C_CMD_10_BITS
@ VSF_I2C_CMD_10_BITS
10-bit addressing mode command. Configures the I2C transaction to use 10-bit slave addressing.
Definition vsf_template_i2c.h:512
VSF_I2C_CMD_7_BITS
@ VSF_I2C_CMD_7_BITS
7-bit addressing mode command. Configures the I2C transaction to use 7-bit slave addressing.
Definition vsf_template_i2c.h:502
VSF_I2C_CMD_NO_START
@ VSF_I2C_CMD_NO_START
No start condition command. Indicates that no START condition should be generated for this transfer....
Definition vsf_template_i2c.h:464
VSF_I2C_CMD_STOP
@ VSF_I2C_CMD_STOP
Stop condition command. Generates a STOP condition on the I2C bus to end the current transaction.
Definition vsf_template_i2c.h:438
VSF_I2C_CMD_RESTART
@ VSF_I2C_CMD_RESTART
Restart condition command. Generates a repeated START condition without releasing the bus....
Definition vsf_template_i2c.h:450
VSF_I2C_CMD_WRITE
@ VSF_I2C_CMD_WRITE
Write command for I2C data transfer. Used to write data on the I2C bus.
Definition vsf_template_i2c.h:408
VSF_I2C_CMD_READ
@ VSF_I2C_CMD_READ
Read command for I2C data transfer. Used to read data from the I2C bus.
Definition vsf_template_i2c.h:418
VSF_I2C_CMD_START
@ VSF_I2C_CMD_START
Start condition command. Generates a START condition on the I2C bus to begin a new transaction.
Definition vsf_template_i2c.h:428
vsf_i2c_fini
void vsf_i2c_fini(vsf_i2c_t *i2c_ptr)
Finalize a I2C instance.
Definition i2c_common.c:46
vsf_i2c_slave_request
vsf_err_t vsf_i2c_slave_request(vsf_i2c_t *i2c_ptr, bool transmit_or_receive, uint_fast16_t count, uint8_t *buffer_ptr)
I2C instance as slave mode requests a transfer.
Definition i2c_common.c:167
vsf_i2c_master_request
vsf_err_t vsf_i2c_master_request(vsf_i2c_t *i2c_ptr, uint16_t address, vsf_i2c_cmd_t cmd, uint_fast16_t count, uint8_t *buffer_ptr)
I2C instance as master mode requests a transfer.
Definition i2c_common.c:155
vsf_i2c_ctrl_t
vsf_i2c_ctrl_t
I2C control commands for hardware-specific operations.
Definition vsf_template_i2c.h:989
__VSF_I2C_CTRL_DUMMP
@ __VSF_I2C_CTRL_DUMMP
Definition vsf_template_i2c.h:1028
vsf_i2c_enable
fsm_rt_t vsf_i2c_enable(vsf_i2c_t *i2c_ptr)
Enable a I2C instance.
Definition i2c_common.c:65
vsf_i2c_slave_fifo_transfer
uint_fast16_t vsf_i2c_slave_fifo_transfer(vsf_i2c_t *i2c_ptr, bool transmit_or_receive, uint_fast16_t count, uint8_t *buffer_ptr)
I2C instance as slave mode performs a FIFO transfer.
Definition i2c_common.c:142
vsf_i2c_irq_enable
void vsf_i2c_irq_enable(vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask)
I2C instance enables interrupts.
Definition i2c_common.c:83
vsf_i2c_irq_mask_t
vsf_i2c_irq_mask_t
Predefined VSF I2C interrupt masks that can be reimplemented in specific HAL drivers....
Definition vsf_template_i2c.h:597
VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT
@ VSF_I2C_IRQ_MASK_MASTER_STOP_DETECT
Master mode: STOP condition detection interrupt. Triggered when STOP condition is detected while in m...
Definition vsf_template_i2c.h:698
VSF_I2C_IRQ_MASK_SLAVE_TX
@ VSF_I2C_IRQ_MASK_SLAVE_TX
Slave mode: Transmit FIFO threshold interrupt. Triggered when transmit FIFO level falls below thresho...
Definition vsf_template_i2c.h:737
VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE
@ VSF_I2C_IRQ_MASK_MASTER_TRANSFER_COMPLETE
Master mode: Transfer completion interrupt. Triggered when the current transfer operation is complete...
Definition vsf_template_i2c.h:636
VSF_I2C_IRQ_MASK_SLAVE_START_OR_RESTART_DETECT
@ VSF_I2C_IRQ_MASK_SLAVE_START_OR_RESTART_DETECT
Slave mode: Repeated START condition detection interrupt. Triggered when repeated START condition is ...
Definition vsf_template_i2c.h:711
VSF_I2C_IRQ_MASK_MASTER_TX
@ VSF_I2C_IRQ_MASK_MASTER_TX
Master mode: Transmit FIFO threshold interrupt. Triggered when transmit FIFO level falls below thresh...
Definition vsf_template_i2c.h:610
VSF_I2C_IRQ_MASK_MASTER_RX
@ VSF_I2C_IRQ_MASK_MASTER_RX
Master mode: Receive FIFO threshold interrupt. Triggered when receive FIFO level exceeds threshold in...
Definition vsf_template_i2c.h:624
VSF_I2C_IRQ_MASK_SLAVE_TRANSFER_COMPLETE
@ VSF_I2C_IRQ_MASK_SLAVE_TRANSFER_COMPLETE
Slave mode: Transfer completion interrupt. Triggered when the current transfer operation is completed...
Definition vsf_template_i2c.h:763
VSF_I2C_IRQ_MASK_MASTER_START_OR_RESTART_DETECT
@ VSF_I2C_IRQ_MASK_MASTER_START_OR_RESTART_DETECT
Master mode: START or RESTART condition detection interrupt. Triggered when START or RESTART conditio...
Definition vsf_template_i2c.h:685
VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK
@ VSF_I2C_IRQ_MASK_MASTER_ADDRESS_NACK
Master mode: Address NACK detection interrupt. Triggered when a NACK is received after sending the ad...
Definition vsf_template_i2c.h:660
VSF_I2C_IRQ_MASK_SLAVE_STOP_DETECT
@ VSF_I2C_IRQ_MASK_SLAVE_STOP_DETECT
Slave mode: STOP condition detection interrupt. Triggered when STOP condition is detected while in sl...
Definition vsf_template_i2c.h:723
VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST
@ VSF_I2C_IRQ_MASK_MASTER_ARBITRATION_LOST
Master mode: Arbitration lost interrupt. Triggered when the master loses arbitration in multi-master ...
Definition vsf_template_i2c.h:648
VSF_I2C_IRQ_MASK_MASTER_TX_NACK_DETECT
@ VSF_I2C_IRQ_MASK_MASTER_TX_NACK_DETECT
Master mode: data transmit NACK detection interrupt. Triggered when a NACK is received during master ...
Definition vsf_template_i2c.h:672
VSF_I2C_IRQ_MASK_SLAVE_RX
@ VSF_I2C_IRQ_MASK_SLAVE_RX
Slave mode: Receive FIFO threshold interrupt. Triggered when receive FIFO level exceeds threshold in ...
Definition vsf_template_i2c.h:751
VSF_I2C_IRQ_ALL_BITS_MASK
@ VSF_I2C_IRQ_ALL_BITS_MASK
Definition vsf_template_i2c.h:814
VSF_I2C_IRQ_MASK_MASTER_ERR
@ VSF_I2C_IRQ_MASK_MASTER_ERR
Combined master error interrupt mask. This mask includes all master mode error interrupts:
Definition vsf_template_i2c.h:783
VSF_I2C_IRQ_MASK_ERR
@ VSF_I2C_IRQ_MASK_ERR
Combined error interrupt mask for both master and slave modes. This mask includes all error interrupt...
Definition vsf_template_i2c.h:809
VSF_I2C_IRQ_MASK_SLAVE_ERR
@ VSF_I2C_IRQ_MASK_SLAVE_ERR
Combined slave error interrupt mask. This mask includes all slave mode error interrupts:
Definition vsf_template_i2c.h:797
vsf_i2c_isr_handler_t
void vsf_i2c_isr_handler_t(void *target_ptr, vsf_i2c_t *i2c_ptr, vsf_i2c_irq_mask_t irq_mask)
I2C interrupt callback function prototype.
Definition vsf_template_i2c.h:929
vsf_i2c_master_fifo_transfer
fsm_rt_t vsf_i2c_master_fifo_transfer(vsf_i2c_t *i2c_ptr, uint16_t address, vsf_i2c_cmd_t cmd, uint_fast16_t count, uint8_t *buffer_ptr, vsf_i2c_cmd_t *cur_cmd_ptr, uint_fast16_t *offset_ptr)
I2C instance as master mode performs a FIFO transfer.
Definition i2c_common.c:128
VSF_I2C_APIS
#define VSF_I2C_APIS(__prefix_name)
I2C API template, used to generate I2C type, specific prefix function declarations,...
Definition vsf_template_i2c.h:210
Generated from commit: vsfteam/vsf@9f48a28