ismrx  2.0.0.0
ismrx.h
Go to the documentation of this file.
1 /****************************************************************************
2 ** Copyright (C) 2020 MikroElektronika d.o.o.
3 ** Contact: https://www.mikroe.com/contact
4 **
5 ** Permission is hereby granted, free of charge, to any person obtaining a copy
6 ** of this software and associated documentation files (the "Software"), to deal
7 ** in the Software without restriction, including without limitation the rights
8 ** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 ** copies of the Software, and to permit persons to whom the Software is
10 ** furnished to do so, subject to the following conditions:
11 ** The above copyright notice and this permission notice shall be
12 ** included in all copies or substantial portions of the Software.
13 **
14 ** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 ** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
16 ** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17 ** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
18 ** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
19 ** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20 ** USE OR OTHER DEALINGS IN THE SOFTWARE.
21 ****************************************************************************/
22 
28 #ifndef ISMRX_H
29 #define ISMRX_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
35 #include "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 
59 #define ISMRX_REG_POWER_CFG 0x00
60 #define ISMRX_REG_CFG 0x01
61 #define ISMRX_REG_CTRL 0x02
62 #define ISMRX_REG_OSC_FREQ 0x03
63 #define ISMRX_REG_OFF_TIMER_MSB 0x04
64 #define ISMRX_REG_OFF_TIMER_LSB 0x05
65 #define ISMRX_REG_CPU_RECOVERY_TIME 0x06
66 #define ISMRX_REG_RF_SETTLE_TIMER_MSB 0x07
67 #define ISMRX_REG_RF_SETTLE_TIMER_LSB 0x08
68 #define ISMRX_REG_STATUS 0x09
69 #define ISMRX_REG_AGC_DWELL_TIMER 0x0A
70  // ismrx_reg
72 
87 #define ISMRX_MODULATION_NULL 0
88 #define ISMRX_MODULATION_ASK 1
89 #define ISMRX_MODULATION_FSK 2
90 
91 #define ISMRX_RECEIVE_MODE_NULL 0
92 #define ISMRX_RECEIVE_MODE_RX 3
93 #define ISMRX_RECEIVE_MODE_DRX 4
94  // ismrx_set
96 
111 #define ISMRX_MAP_MIKROBUS( cfg, mikrobus ) \
112  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
113  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
114  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
115  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
116  // ismrx_map // ismrx
119 
124 typedef struct
125 {
126  // Output pins
127  digital_out_t mosi;
129  // Input pins
130  digital_in_t miso;
132  // Modules
133  spi_master_t spi;
134  pin_name_t chip_select;
136  uint8_t modulation;
137  uint8_t receive_mode;
138 
139 } ismrx_t;
140 
145 typedef struct
146 {
147  // Communication gpio pins
148  pin_name_t miso;
149  pin_name_t mosi;
150  pin_name_t sck;
151  pin_name_t cs;
153  // static variable
154  uint32_t spi_speed;
155  spi_master_mode_t spi_mode;
156  spi_master_chip_select_polarity_t cs_polarity;
158 } ismrx_cfg_t;
159 
164 typedef enum
165 {
166  ISMRX_OK = 0,
170 
172 
189 
202 err_t ismrx_init ( ismrx_t *ctx, ismrx_cfg_t *cfg );
203 
216 err_t ismrx_task_init ( ismrx_t *ctx, ismrx_cfg_t *cfg );
217 
230 err_t ismrx_default_cfg ( ismrx_t *ctx );
231 
245 err_t ismrx_generic_write ( ismrx_t *ctx, uint8_t reg, uint8_t data_in );
246 
261 err_t ismrx_generic_read ( ismrx_t *ctx, uint8_t reg, uint8_t *data_out );
262 
275 
283 void ismrx_start_drx ( ismrx_t *ctx );
284 
292 void ismrx_stop_drx ( ismrx_t *ctx );
293 
301 uint8_t ismrx_get_data ( ismrx_t *ctx );
302 
303 #ifdef __cplusplus
304 }
305 #endif
306 #endif // ISMRX_H
307  // ismrx
309 
310 // ------------------------------------------------------------------------ END
ISMRX_OK
@ ISMRX_OK
Definition: ismrx.h:166
ISMRX_ERROR
@ ISMRX_ERROR
Definition: ismrx.h:167
ismrx_t
ISM RX Click context object.
Definition: ismrx.h:125
ismrx_task_init
err_t ismrx_task_init(ismrx_t *ctx, ismrx_cfg_t *cfg)
ISM RX initialization function.
ismrx_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: ismrx.h:155
ismrx_cfg_t::sck
pin_name_t sck
Definition: ismrx.h:150
ismrx_cfg_t::spi_speed
uint32_t spi_speed
Definition: ismrx.h:154
ismrx_get_data
uint8_t ismrx_get_data(ismrx_t *ctx)
ISM RX get miso pin state.
ismrx_cfg_t
ISM RX Click configuration object.
Definition: ismrx.h:146
ismrx_cfg_t::mosi
pin_name_t mosi
Definition: ismrx.h:149
ismrx_t::chip_select
pin_name_t chip_select
Definition: ismrx.h:134
ismrx_t::mosi
digital_out_t mosi
Definition: ismrx.h:127
ismrx_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ismrx.h:156
ISMRX_CONTEXT_MODULATION_ERROR
@ ISMRX_CONTEXT_MODULATION_ERROR
Definition: ismrx.h:168
ismrx_default_cfg
err_t ismrx_default_cfg(ismrx_t *ctx)
ISM RX default configuration function.
ismrx_cfg_setup
void ismrx_cfg_setup(ismrx_cfg_t *cfg)
ISM RX configuration object setup function.
ismrx_generic_read
err_t ismrx_generic_read(ismrx_t *ctx, uint8_t reg, uint8_t *data_out)
ISM RX data reading function.
ismrx_t::spi
spi_master_t spi
Definition: ismrx.h:133
ismtx_return_value_t
ismtx_return_value_t
ISM RX Click return value data.
Definition: ismrx.h:165
ismrx_start_drx
void ismrx_start_drx(ismrx_t *ctx)
ISM RX start receiving signal.
ismrx_cfg_t::miso
pin_name_t miso
Definition: ismrx.h:148
ismrx_t::receive_mode
uint8_t receive_mode
Definition: ismrx.h:137
ismrx_t::modulation
uint8_t modulation
Definition: ismrx.h:136
ismrx_stop_drx
void ismrx_stop_drx(ismrx_t *ctx)
ISM RX stop receiving signal.
ismrx_t::miso
digital_in_t miso
Definition: ismrx.h:130
ismrx_master_reset
err_t ismrx_master_reset(ismrx_t *ctx)
ISM RX software reset.
ISMRX_CONTEXT_RECEIVE_MODE_ERROR
@ ISMRX_CONTEXT_RECEIVE_MODE_ERROR
Definition: ismrx.h:169
ismrx_cfg_t::cs
pin_name_t cs
Definition: ismrx.h:151
ismrx_init
err_t ismrx_init(ismrx_t *ctx, ismrx_cfg_t *cfg)
ISM RX initialization function.
ismrx_generic_write
err_t ismrx_generic_write(ismrx_t *ctx, uint8_t reg, uint8_t data_in)
ISM RX data writing function.