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 "mikrosdk_version.h"
36 
37 #ifdef __GNUC__
38 #if mikroSDK_GET_VERSION < 20800ul
39 #include "rcu_delays.h"
40 #else
41 #include "delays.h"
42 #endif
43 #endif
44 
45 #include "drv_digital_out.h"
46 #include "drv_digital_in.h"
47 #include "drv_spi_master.h"
48 
69 #define ISMRX_REG_POWER_CFG 0x00
70 #define ISMRX_REG_CFG 0x01
71 #define ISMRX_REG_CTRL 0x02
72 #define ISMRX_REG_OSC_FREQ 0x03
73 #define ISMRX_REG_OFF_TIMER_MSB 0x04
74 #define ISMRX_REG_OFF_TIMER_LSB 0x05
75 #define ISMRX_REG_CPU_RECOVERY_TIME 0x06
76 #define ISMRX_REG_RF_SETTLE_TIMER_MSB 0x07
77 #define ISMRX_REG_RF_SETTLE_TIMER_LSB 0x08
78 #define ISMRX_REG_STATUS 0x09
79 #define ISMRX_REG_AGC_DWELL_TIMER 0x0A
80  // ismrx_reg
82 
97 #define ISMRX_MODULATION_NULL 0
98 #define ISMRX_MODULATION_ASK 1
99 #define ISMRX_MODULATION_FSK 2
100 
101 #define ISMRX_RECEIVE_MODE_NULL 0
102 #define ISMRX_RECEIVE_MODE_RX 3
103 #define ISMRX_RECEIVE_MODE_DRX 4
104  // ismrx_set
106 
121 #define ISMRX_MAP_MIKROBUS( cfg, mikrobus ) \
122  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
123  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
124  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
125  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS );
126  // ismrx_map // ismrx
129 
134 typedef struct
135 {
136  // Output pins
137  digital_out_t mosi;
139  // Input pins
140  digital_in_t miso;
142  // Modules
143  spi_master_t spi;
144  pin_name_t chip_select;
146  uint8_t modulation;
147  uint8_t receive_mode;
148 
149 } ismrx_t;
150 
155 typedef struct
156 {
157  // Communication gpio pins
158  pin_name_t miso;
159  pin_name_t mosi;
160  pin_name_t sck;
161  pin_name_t cs;
163  // static variable
164  uint32_t spi_speed;
165  spi_master_mode_t spi_mode;
166  spi_master_chip_select_polarity_t cs_polarity;
168 } ismrx_cfg_t;
169 
174 typedef enum
175 {
176  ISMRX_OK = 0,
180 
182 
199 
212 err_t ismrx_init ( ismrx_t *ctx, ismrx_cfg_t *cfg );
213 
226 err_t ismrx_task_init ( ismrx_t *ctx, ismrx_cfg_t *cfg );
227 
240 err_t ismrx_default_cfg ( ismrx_t *ctx );
241 
255 err_t ismrx_generic_write ( ismrx_t *ctx, uint8_t reg, uint8_t data_in );
256 
271 err_t ismrx_generic_read ( ismrx_t *ctx, uint8_t reg, uint8_t *data_out );
272 
285 
293 void ismrx_start_drx ( ismrx_t *ctx );
294 
302 void ismrx_stop_drx ( ismrx_t *ctx );
303 
311 uint8_t ismrx_get_data ( ismrx_t *ctx );
312 
313 #ifdef __cplusplus
314 }
315 #endif
316 #endif // ISMRX_H
317  // ismrx
319 
320 // ------------------------------------------------------------------------ END
ISMRX_OK
@ ISMRX_OK
Definition: ismrx.h:176
ISMRX_ERROR
@ ISMRX_ERROR
Definition: ismrx.h:177
ismrx_t
ISM RX Click context object.
Definition: ismrx.h:135
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:165
ismrx_cfg_t::sck
pin_name_t sck
Definition: ismrx.h:160
ismrx_cfg_t::spi_speed
uint32_t spi_speed
Definition: ismrx.h:164
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:156
ismrx_cfg_t::mosi
pin_name_t mosi
Definition: ismrx.h:159
ismrx_t::chip_select
pin_name_t chip_select
Definition: ismrx.h:144
ismrx_t::mosi
digital_out_t mosi
Definition: ismrx.h:137
ismrx_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: ismrx.h:166
ISMRX_CONTEXT_MODULATION_ERROR
@ ISMRX_CONTEXT_MODULATION_ERROR
Definition: ismrx.h:178
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:143
ismtx_return_value_t
ismtx_return_value_t
ISM RX Click return value data.
Definition: ismrx.h:175
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:158
ismrx_t::receive_mode
uint8_t receive_mode
Definition: ismrx.h:147
ismrx_t::modulation
uint8_t modulation
Definition: ismrx.h:146
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:140
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:179
ismrx_cfg_t::cs
pin_name_t cs
Definition: ismrx.h:161
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.