spiisolator 2.0.0.0
spiisolator.h
Go to the documentation of this file.
1/*
2 * MikroSDK - MikroE Software Development Kit
3 * Copyright© 2020 MikroElektronika d.o.o.
4 *
5 * Permission is hereby granted, free of charge, to any person
6 * obtaining a copy of this software and associated documentation
7 * files (the "Software"), to deal in the Software without restriction,
8 * including without limitation the rights to use, copy, modify, merge,
9 * publish, distribute, sublicense, and/or sell copies of the Software,
10 * and to permit persons to whom the Software is furnished to do so,
11 * subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice shall be
14 * included in all copies or substantial portions of the Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22 * OR OTHER DEALINGS IN THE SOFTWARE.
23 */
32// ----------------------------------------------------------------------------
33
34#ifndef SPIISOLATOR_H
35#define SPIISOLATOR_H
36
37#include "drv_digital_out.h"
38#include "drv_digital_in.h"
39#include "drv_spi_master.h"
40
41
42// -------------------------------------------------------------- PUBLIC MACROS
53#define SPIISOLATOR_MAP_MIKROBUS( cfg, mikrobus ) \
54 cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
55 cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
56 cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
57 cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
64#define SPIISOLATOR_RETVAL uint8_t
65
66#define SPIISOLATOR_OK 0x00
67#define SPIISOLATOR_INIT_ERROR 0xFF
74#define SPIISOLATOR_PRESSURE3_SPI_CMD_WRITE 0x7F
75#define SPIISOLATOR_PRESSURE3_SPI_CMD_READ 0x80
82#define SPIISOLATOR_PRESSURE3_REG_PSR_B2 0x00
83#define SPIISOLATOR_PRESSURE3_REG_PSR_B1 0x01
84#define SPIISOLATOR_PRESSURE3_REG_PSR_B0 0x02
85#define SPIISOLATOR_PRESSURE3_REG_TMP_B2 0x03
86#define SPIISOLATOR_PRESSURE3_REG_TMP_B1 0x04
87#define SPIISOLATOR_PRESSURE3_REG_TMP_B0 0x05
88#define SPIISOLATOR_PRESSURE3_REG_PRS_CFG 0x06
89#define SPIISOLATOR_PRESSURE3_REG_TMP_CFG 0x07
90#define SPIISOLATOR_PRESSURE3_REG_MEAS_CFG 0x08
91#define SPIISOLATOR_PRESSURE3_REG_CFG_REG 0x09
92#define SPIISOLATOR_PRESSURE3_REG_INT_STS 0x0A
93#define SPIISOLATOR_PRESSURE3_REG_FIFO_STS 0x0B
94#define SPIISOLATOR_PRESSURE3_REG_RESET 0x0C
95#define SPIISOLATOR_PRESSURE3_REG_PRODUCT_ID 0x0D
96#define SPIISOLATOR_PRESSURE3_REG_COEF_C0_MBS 0x10
97#define SPIISOLATOR_PRESSURE3_REG_COEF_C0_LBS_C1_MBS 0x11
98#define SPIISOLATOR_PRESSURE3_REG_COEF_C1_LBS 0x12
99#define SPIISOLATOR_PRESSURE3_REG_COEF_C00_MBS 0x13
100#define SPIISOLATOR_PRESSURE3_REG_COEF_C00_LSB 0x14
101#define SPIISOLATOR_PRESSURE3_REG_COEF_C00_XLSB_C10_MSB 0x15
102#define SPIISOLATOR_PRESSURE3_REG_COEF_C10_LSB 0x16
103#define SPIISOLATOR_PRESSURE3_REG_COEF_C10_XLSB 0x17
104#define SPIISOLATOR_PRESSURE3_REG_COEF_C01_MSB 0x18
105#define SPIISOLATOR_PRESSURE3_REG_COEF_C01_LSB 0x19
106#define SPIISOLATOR_PRESSURE3_REG_COEF_C11_MSB 0x1A
107#define SPIISOLATOR_PRESSURE3_REG_COEF_C11_LSB 0x1B
108#define SPIISOLATOR_PRESSURE3_REG_COEF_C20_MSB 0x1C
109#define SPIISOLATOR_PRESSURE3_REG_COEF_C20_LSB 0x1D
110#define SPIISOLATOR_PRESSURE3_REG_COEF_C21_MSB 0x1E
111#define SPIISOLATOR_PRESSURE3_REG_COEF_C21_LSB 0x1F
112#define SPIISOLATOR_PRESSURE3_REG_COEF_C30_MSB 0x20
113#define SPIISOLATOR_PRESSURE3_REG_COEF_C30_LSB 0x21
114#define SPIISOLATOR_PRESSURE3_REG_COEF_SRCE 0x28
121#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_1_PER_SEC 0x00
122#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_2_PER_SEC 0x10
123#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_4_PER_SEC 0x20
124#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_8_PER_SEC 0x30
125#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_16_PER_SEC 0x40
126#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_32_PER_SEC 0x50
127#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_64_PER_SEC 0x60
128#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_RATE_128_PER_SEC 0x70
129#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_1_PER_SEC 0x00
130#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_2_PER_SEC 0x01
131#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_4_PER_SEC 0x02
132#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_8_PER_SEC 0x03
133#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_16_PER_SEC 0x04
134#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_32_PER_SEC 0x05
135#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_64_PER_SEC 0x06
136#define SPIISOLATOR_PRESSURE3_BIT_MASK_PM_PRC_128_PER_SEC 0x07
143#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_EXT_INTERNAL_SENSOR 0x00
144#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_EXT_EXTERNAL_SENSOR 0x80
145#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_1_PER_SEC 0x00
146#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_2_PER_SEC 0x10
147#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_4_PER_SEC 0x20
148#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_8_PER_SEC 0x30
149#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_16_PER_SEC 0x40
150#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_32_PER_SEC 0x50
151#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_64_PER_SEC 0x60
152#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_RATE_128_PER_SEC 0x70
153#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_1_PER_SEC 0x00
154#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_2_PER_SEC 0x01
155#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_4_PER_SEC 0x02
156#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_8_PER_SEC 0x03
157#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_16_PER_SEC 0x04
158#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_32_PER_SEC 0x05
159#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_64_PER_SEC 0x06
160#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_PRC_128_PER_SEC 0x07
167#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_COEF_RDY_AVB 0x80
168#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_COEF_RDY_NO_AVB 0x00
169#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_SENSOR_RDY_CMP 0x40
170#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_SENSOR_RDY_NO_CMP 0x00
171#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_TMP_RDY 0x20
172#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_PRS_RDY 0x10
173#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_IDLE 0x00
174#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_PRS 0x01
175#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_TMP 0x02
176#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_CNT_PRS 0x05
177#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_CNT_TMP 0x06
178#define SPIISOLATOR_PRESSURE3_BIT_MASK_MEAS_CFG_MEAS_CTRL_CNT_PRS_TMP 0x07
185#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_HL_LOW 0x00
186#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_HL_HIGH 0x80
187#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_FIFO_DISABLE 0x00
188#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_FIFO_ENABLE 0x40
189#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_TMP_DISABLE 0x00
190#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_TMP_ENABLE 0x20
191#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_PRS_DISABLE 0x00
192#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_INT_PRS_ENABLE 0x10
193#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_T_SHIFT_NO_SHIFT 0x00
194#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_T_SHIFT_SHIFT 0x08
195#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_P_SHIFT_NO_SHIFT 0x00
196#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_P_SHIFT_SHIFT 0x04
197#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_FIFO_EN_DISABLE 0x00
198#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_FIFO_EN_ENABLE 0x02
199#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_SPI_MODE_DISABLE 0x00
200#define SPIISOLATOR_PRESSURE3_BIT_MASK_CFG_REG_SPI_MODE_ENABLE 0x01
207#define SPIISOLATOR_PRESSURE3_BIT_MASK_INT_STS_INT_FIFO_FULL_NO_ACTIVE 0x00
208#define SPIISOLATOR_PRESSURE3_BIT_MASK_INT_STS_INT_FIFO_FULL_ACTIVE 0x04
209#define SPIISOLATOR_PRESSURE3_BIT_MASK_INT_STS_INT_TMP_NO_ACTIVE 0x00
210#define SPIISOLATOR_PRESSURE3_BIT_MASK_INT_STS_INT_TMP_ACTIVE 0x02
211#define SPIISOLATOR_PRESSURE3_BIT_MASK_INT_STS_INT_PRS_NO_ACTIVE 0x00
212#define SPIISOLATOR_PRESSURE3_BIT_MASK_INT_STS_INT_PRS_ACTIVE 0x01
219#define SPIISOLATOR_PRESSURE3_BIT_MASK_FIFO_STS_FIFO_FULL_NO 0x00
220#define SPIISOLATOR_PRESSURE3_BIT_MASK_FIFO_STS_FIFO_FULL_FULL 0x02
221#define SPIISOLATOR_PRESSURE3_BIT_MASK_FIFO_STS_FIFO_EMPTY_NO 0x00
222#define SPIISOLATOR_PRESSURE3_BIT_MASK_FIFO_STS_FIFO_EMPTY_EMPTY 0x01
229#define SPIISOLATOR_PRESSURE3_BIT_MASK_RESET_SOFT_RST 0x09
236#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_COEF_SRCE_INTERNAL_SENSOR 0x00
237#define SPIISOLATOR_PRESSURE3_BIT_MASK_TMP_COEF_SRCE_EXTERNAL_SENSOR 0x80 // End group macro
241// --------------------------------------------------------------- PUBLIC TYPES
250typedef struct
251{
252
253 uint8_t reg_address;
254 uint8_t cmd;
255
256} addr_cmd_t;
257
258
262typedef struct
263{
264 digital_out_t cs;
265
266 // Modules
267
268 spi_master_t spi;
269 pin_name_t chip_select;
270
272
276typedef struct
277{
278 // Communication gpio pins
279
280 pin_name_t miso;
281 pin_name_t mosi;
282 pin_name_t sck;
283 pin_name_t cs;
284
285 // static variable
286
287 uint32_t spi_speed;
288 spi_master_mode_t spi_mode;
289 spi_master_chip_select_polarity_t cs_polarity;
290
292 // End types group
294
295// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
296
301#ifdef __cplusplus
302extern "C"{
303#endif
304
314
323
336(
337 spiisolator_t *ctx,
338 uint8_t *wr_buf,
339 uint16_t wr_len,
340 uint8_t *rd_buf,
341 uint16_t rd_len
342);
343
344
345void spiisolator_write_cmd ( spiisolator_t *ctx, uint8_t cmd, uint8_t tx_data );
346
359void spiisolator_write_byte ( spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint8_t write_data );
360
374uint8_t spiisolator_read_byte ( spiisolator_t *ctx, uint8_t reg_address, uint8_t read_cmd );
375
387void spiisolator_write_data ( spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint16_t write_data );
388
400uint16_t spiisolator_read_data ( spiisolator_t *ctx, uint8_t reg_address, uint8_t read_cmd );
401
414void spiisolator_write_bytes ( spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint8_t *write_data, uint16_t n_bytes );
415
428void spiisolator_read_bytes ( spiisolator_t *ctx,uint8_t reg_address, uint8_t read_cmd, uint8_t *read_data, uint16_t n_bytes );
429
430#ifdef __cplusplus
431}
432#endif
433#endif // _SPIISOLATOR_H_
434 // End public_function group
437
438// ------------------------------------------------------------------------- END
#define SPIISOLATOR_RETVAL
Definition: spiisolator.h:64
uint8_t spiisolator_read_byte(spiisolator_t *ctx, uint8_t reg_address, uint8_t read_cmd)
Read the byte of data function.
void spiisolator_cfg_setup(spiisolator_cfg_t *cfg)
Config Object Initialization function.
uint16_t spiisolator_read_data(spiisolator_t *ctx, uint8_t reg_address, uint8_t read_cmd)
Read 16-bit data function.
void spiisolator_write_bytes(spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint8_t *write_data, uint16_t n_bytes)
Sequential write function.
void spiisolator_read_bytes(spiisolator_t *ctx, uint8_t reg_address, uint8_t read_cmd, uint8_t *read_data, uint16_t n_bytes)
Sequential read function.
void spiisolator_generic_transfer(spiisolator_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
Generic transfer function.
void spiisolator_write_data(spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint16_t write_data)
Write 16-bit data function.
SPIISOLATOR_RETVAL spiisolator_init(spiisolator_t *ctx, spiisolator_cfg_t *cfg)
Initialization function.
void spiisolator_write_byte(spiisolator_t *ctx, uint8_t reg_address, uint8_t write_cmd, uint8_t write_data)
Write the byte of data function.
void spiisolator_write_cmd(spiisolator_t *ctx, uint8_t cmd, uint8_t tx_data)
Definition: spiisolator.h:251
uint8_t cmd
Definition: spiisolator.h:254
uint8_t reg_address
Definition: spiisolator.h:253
Click configuration structure definition.
Definition: spiisolator.h:277
spi_master_chip_select_polarity_t cs_polarity
Definition: spiisolator.h:289
pin_name_t sck
Definition: spiisolator.h:282
spi_master_mode_t spi_mode
Definition: spiisolator.h:288
pin_name_t mosi
Definition: spiisolator.h:281
uint32_t spi_speed
Definition: spiisolator.h:287
pin_name_t miso
Definition: spiisolator.h:280
pin_name_t cs
Definition: spiisolator.h:283
Click ctx object definition.
Definition: spiisolator.h:263
digital_out_t cs
Definition: spiisolator.h:264
spi_master_t spi
Definition: spiisolator.h:268
pin_name_t chip_select
Definition: spiisolator.h:269