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
|
/*
* Copyright (c) 2020 - 2026 Renesas Electronics Corporation and/or its affiliates
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef R_I2C_MASTER_API_H
#define R_I2C_MASTER_API_H
/*******************************************************************************************************************//**
* @ingroup RENESAS_CONNECTIVITY_INTERFACES
* @defgroup I2C_MASTER_API I2C Master Interface
* @brief Interface for I2C master communication.
*
* @section I2C_MASTER_API_SUMMARY Summary
* The I2C master interface provides a common API for I2C HAL drivers. The I2C master interface supports:
* - Interrupt driven transmit/receive processing
* - Callback function support which can return an event code
*
*
* @{
**********************************************************************************************************************/
/***********************************************************************************************************************
* Includes
**********************************************************************************************************************/
/* Register definitions, common services and error codes. */
#include "bsp_api.h"
#include "r_transfer_api.h"
/* Common macro for FSP header files. There is also a corresponding FSP_FOOTER macro at the end of this file. */
FSP_HEADER
/**********************************************************************************************************************
* Macro definitions
**********************************************************************************************************************/
/**********************************************************************************************************************
* Typedef definitions
**********************************************************************************************************************/
/** Communication speed options */
typedef enum e_i2c_master_rate
{
I2C_MASTER_RATE_STANDARD = 100000, ///< 100 kHz
I2C_MASTER_RATE_FAST = 400000, ///< 400 kHz
I2C_MASTER_RATE_FASTPLUS = 1000000, ///< 1 MHz
I2C_MASTER_RATE_HIGHSPEED = 3400000 ///< 3.4 MHz
} i2c_master_rate_t;
/** Addressing mode options */
typedef enum e_i2c_master_addr_mode
{
I2C_MASTER_ADDR_MODE_7BIT = 1, ///< Use 7-bit addressing mode
I2C_MASTER_ADDR_MODE_10BIT = 2, ///< Use 10-bit addressing mode
} i2c_master_addr_mode_t;
/** Callback events */
typedef enum e_i2c_master_event
{
I2C_MASTER_EVENT_ABORTED = 1, ///< A transfer was aborted
I2C_MASTER_EVENT_RX_COMPLETE = 2, ///< A receive operation was completed successfully
I2C_MASTER_EVENT_TX_COMPLETE = 3, ///< A transmit operation was completed successfully
I2C_MASTER_EVENT_START = 4, ///< I2C sent a start condition
I2C_MASTER_EVENT_BYTE_ACK = 5, ///< I2C finished sending/receiving 1 data byte
} i2c_master_event_t;
/** I2C callback parameter definition */
typedef struct st_i2c_master_callback_args
{
void * p_context; ///< Pointer to user-provided context
i2c_master_event_t event; ///< Event code
} i2c_master_callback_args_t;
/** I2C status indicators */
typedef struct st_i2c_master_status
{
bool open; ///< True if driver is open
} i2c_master_status_t;
/** I2C configuration block */
typedef struct st_i2c_master_cfg
{
/** Generic configuration */
uint8_t channel; ///< Identifier recognizable by implementation
i2c_master_rate_t rate; ///< Device's maximum clock rate from enum i2c_rate_t
uint32_t slave; ///< The address of the slave device
i2c_master_addr_mode_t addr_mode; ///< Indicates how slave fields should be interpreted
uint8_t ipl; ///< Interrupt priority level. Same for RXI, TXI, TEI and ERI.
IRQn_Type rxi_irq; ///< Receive IRQ number
IRQn_Type txi_irq; ///< Transmit IRQ number
IRQn_Type tei_irq; ///< Transmit end IRQ number
IRQn_Type eri_irq; ///< Error IRQ number
/** Transfer API support */
transfer_instance_t const * p_transfer_tx; ///< Transfer instance for I2C transmit. Set to NULL if unused.
transfer_instance_t const * p_transfer_rx; ///< Transfer instance for I2C receive. Set to NULL if unused.
/** Parameters to control software behavior */
void (* p_callback)(i2c_master_callback_args_t * p_args); ///< Pointer to callback function
void * p_context; ///< Pointer to the user-provided context
/** Implementation-specific configuration */
void const * p_extend; ///< Any configuration data needed by the hardware
} i2c_master_cfg_t;
/** I2C control block. Allocate an instance specific control block to pass into the I2C API calls.
*/
typedef void i2c_master_ctrl_t;
/** Interface definition for I2C access as master */
typedef struct st_i2c_master_api
{
/** Opens the I2C Master driver and initializes the hardware.
*
* @param[in] p_ctrl Pointer to control block. Must be declared by user. Elements are set here.
* @param[in] p_cfg Pointer to configuration structure.
*/
fsp_err_t (* open)(i2c_master_ctrl_t * const p_ctrl, i2c_master_cfg_t const * const p_cfg);
/** Performs a read operation on an I2C Master device.
*
* @param[in] p_ctrl Pointer to control block set in i2c_master_api_t::open call.
* @param[in] p_dest Pointer to the location to store read data.
* @param[in] bytes Number of bytes to read.
* @param[in] restart Specify if the restart condition should be issued after reading.
*/
fsp_err_t (* read)(i2c_master_ctrl_t * const p_ctrl, uint8_t * const p_dest, uint32_t const bytes,
bool const restart);
/** Performs a write operation on an I2C Master device.
*
* @param[in] p_ctrl Pointer to control block set in i2c_master_api_t::open call.
* @param[in] p_src Pointer to the location to get write data from.
* @param[in] bytes Number of bytes to write.
* @param[in] restart Specify if the restart condition should be issued after writing.
*/
fsp_err_t (* write)(i2c_master_ctrl_t * const p_ctrl, uint8_t * const p_src, uint32_t const bytes,
bool const restart);
/** Performs a reset of the peripheral.
*
* @param[in] p_ctrl Pointer to control block set in i2c_master_api_t::open call.
*/
fsp_err_t (* abort)(i2c_master_ctrl_t * const p_ctrl);
/** Sets address of the slave device without reconfiguring the bus.
*
* @param[in] p_ctrl Pointer to control block set in i2c_master_api_t::open call.
* @param[in] slave_address Address of the slave device.
* @param[in] address_mode Addressing mode.
*/
fsp_err_t (* slaveAddressSet)(i2c_master_ctrl_t * const p_ctrl, uint32_t const slave,
i2c_master_addr_mode_t const addr_mode);
/**
* Specify callback function and optional context pointer and working memory pointer.
*
* @param[in] p_ctrl Pointer to the IIC Master control block.
* @param[in] p_callback Callback function
* @param[in] p_context Pointer to send to callback function
* @param[in] p_working_memory Pointer to volatile memory where callback structure can be allocated.
* Callback arguments allocated here are only valid during the callback.
*/
fsp_err_t (* callbackSet)(i2c_master_ctrl_t * const p_ctrl, void (* p_callback)(i2c_master_callback_args_t *),
void * const p_context, i2c_master_callback_args_t * const p_callback_memory);
/** Gets the status of the configured I2C device.
*
* @param[in] p_ctrl Pointer to the IIC Master control block.
* @param[out] p_status Pointer to store current status.
*/
fsp_err_t (* statusGet)(i2c_master_ctrl_t * const p_ctrl, i2c_master_status_t * p_status);
/** Closes the driver and releases the I2C Master device.
*
* @param[in] p_ctrl Pointer to control block set in i2c_master_api_t::open call.
*/
fsp_err_t (* close)(i2c_master_ctrl_t * const p_ctrl);
} i2c_master_api_t;
/** This structure encompasses everything that is needed to use an instance of this interface. */
typedef struct st_i2c_master_instance
{
i2c_master_ctrl_t * p_ctrl; ///< Pointer to the control structure for this instance
i2c_master_cfg_t const * p_cfg; ///< Pointer to the configuration structure for this instance
i2c_master_api_t const * p_api; ///< Pointer to the API structure for this instance
} i2c_master_instance_t;
/******************************************************************************************************************//**
* @} (end defgroup I2C_MASTER_API)
*********************************************************************************************************************/
/* Common macro for FSP header files. There is also a corresponding FSP_HEADER macro at the top of this file. */
FSP_FOOTER
#endif
|
