rotaryr2  2.1.0.0
rotaryr2.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 ROTARYR2_H
29 #define ROTARYR2_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 #include "spi_specifics.h"
49 
65 #define ROTARYR2_SET_LED_OFF 0x0000u
66 #define ROTARYR2_SET_LED_DATA_1 0x0001u
67 #define ROTARYR2_SET_LED_DATA_2 0x0002u
68 #define ROTARYR2_SET_LED_DATA_3 0x0004u
69 #define ROTARYR2_SET_LED_DATA_4 0x0008u
70 #define ROTARYR2_SET_LED_DATA_5 0x0010u
71 #define ROTARYR2_SET_LED_DATA_6 0x0020u
72 #define ROTARYR2_SET_LED_DATA_7 0x0040u
73 #define ROTARYR2_SET_LED_DATA_8 0x0080u
74 #define ROTARYR2_SET_LED_DATA_9 0x0100u
75 #define ROTARYR2_SET_LED_DATA_10 0x0200u
76 #define ROTARYR2_SET_LED_DATA_11 0x0400u
77 #define ROTARYR2_SET_LED_DATA_12 0x0800u
78 #define ROTARYR2_SET_LED_DATA_13 0x1000u
79 #define ROTARYR2_SET_LED_DATA_14 0x2000u
80 #define ROTARYR2_SET_LED_DATA_15 0x4000u
81 #define ROTARYR2_SET_LED_DATA_16 0x8000u
82 
87 #define ROTARYR2_SET_LED_POS_1 1
88 #define ROTARYR2_SET_LED_POS_2 2
89 #define ROTARYR2_SET_LED_POS_3 3
90 #define ROTARYR2_SET_LED_POS_4 4
91 #define ROTARYR2_SET_LED_POS_5 5
92 #define ROTARYR2_SET_LED_POS_6 6
93 #define ROTARYR2_SET_LED_POS_7 7
94 #define ROTARYR2_SET_LED_POS_8 8
95 #define ROTARYR2_SET_LED_POS_9 9
96 #define ROTARYR2_SET_LED_POS_10 10
97 #define ROTARYR2_SET_LED_POS_11 11
98 #define ROTARYR2_SET_LED_POS_12 12
99 #define ROTARYR2_SET_LED_POS_13 13
100 #define ROTARYR2_SET_LED_POS_14 14
101 #define ROTARYR2_SET_LED_POS_15 15
102 #define ROTARYR2_SET_LED_POS_16 16
103 
112 #define ROTARYR2_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
113 #define ROTARYR2_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
114  // rotaryr2_set
116 
131 #define ROTARYR2_MAP_MIKROBUS( cfg, mikrobus ) \
132  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
133  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
134  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
135  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
136  cfg.enb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
137  cfg.ena = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
138  cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
139  // rotaryr2_map // rotaryr2
142 
147 typedef struct
148 {
149  // Input pins
150  digital_in_t enb;
151  digital_in_t ena;
152  digital_in_t sw;
154  // Modules
155  spi_master_t spi;
157  pin_name_t chip_select;
159 } rotaryr2_t;
160 
165 typedef struct
166 {
167  // Communication gpio pins
168  pin_name_t miso;
169  pin_name_t mosi;
170  pin_name_t sck;
171  pin_name_t cs;
173  // Additional gpio pins
174  pin_name_t enb;
175  //pin_name_t rst; /**< Description. */
176  pin_name_t ena;
177  pin_name_t sw;
179  // static variable
180  uint32_t spi_speed;
181  spi_master_mode_t spi_mode;
182  spi_master_chip_select_polarity_t cs_polarity;
185 
190 typedef enum
191 {
193  ROTARYR2_ERROR = -1
194 
196 
213 
228 
242 
256 err_t rotaryr2_set_led_data ( rotaryr2_t *ctx, uint16_t data_in );
257 
271 err_t rotaryr2_get_led_data ( rotaryr2_t *ctx, uint16_t *data_out );
272 
286 err_t rotaryr2_set_led_pos ( rotaryr2_t *ctx, uint8_t led_pos );
287 
299 
311 
323 
324 #ifdef __cplusplus
325 }
326 #endif
327 #endif // ROTARYR2_H
328  // rotaryr2
330 
331 // ------------------------------------------------------------------------ END
rotaryr2_t::sw
digital_in_t sw
Definition: rotaryr2.h:152
rotaryr2_cfg_t::ena
pin_name_t ena
Definition: rotaryr2.h:176
rotaryr2_get_state_ena
uint8_t rotaryr2_get_state_ena(rotaryr2_t *ctx)
Rotary R 2 get ena state function.
rotaryr2_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rotaryr2.h:182
rotaryr2_cfg_t::sw
pin_name_t sw
Definition: rotaryr2.h:177
rotaryr2_cfg_t::mosi
pin_name_t mosi
Definition: rotaryr2.h:169
rotaryr2_t::enb
digital_in_t enb
Definition: rotaryr2.h:150
rotaryr2_default_cfg
err_t rotaryr2_default_cfg(rotaryr2_t *ctx)
Rotary R 2 default configuration function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
rotaryr2_get_led_data
err_t rotaryr2_get_led_data(rotaryr2_t *ctx, uint16_t *data_out)
Rotary R 2 get LED data function.
rotaryr2_cfg_setup
void rotaryr2_cfg_setup(rotaryr2_cfg_t *cfg)
Rotary R 2 configuration object setup function.
rotaryr2_get_state_enb
uint8_t rotaryr2_get_state_enb(rotaryr2_t *ctx)
Rotary R 2 get enb state function.
rotaryr2_t
Rotary R 2 Click context object.
Definition: rotaryr2.h:148
rotaryr2_t::spi
spi_master_t spi
Definition: rotaryr2.h:155
rotaryr2_set_led_pos
err_t rotaryr2_set_led_pos(rotaryr2_t *ctx, uint8_t led_pos)
Rotary R 2 set LED position function.
rotaryr2_t::ena
digital_in_t ena
Definition: rotaryr2.h:151
rotaryr2_return_value_t
rotaryr2_return_value_t
Rotary R 2 Click return value data.
Definition: rotaryr2.h:191
rotaryr2_get_state_switch
uint8_t rotaryr2_get_state_switch(rotaryr2_t *ctx)
Rotary R 2 get switch state function.
rotaryr2_cfg_t::enb
pin_name_t enb
Definition: rotaryr2.h:174
rotaryr2_init
err_t rotaryr2_init(rotaryr2_t *ctx, rotaryr2_cfg_t *cfg)
Rotary R 2 initialization function.
rotaryr2_cfg_t::spi_speed
uint32_t spi_speed
Definition: rotaryr2.h:180
ROTARYR2_OK
@ ROTARYR2_OK
Definition: rotaryr2.h:192
rotaryr2_t::chip_select
pin_name_t chip_select
Definition: rotaryr2.h:157
rotaryr2_cfg_t::sck
pin_name_t sck
Definition: rotaryr2.h:170
rotaryr2_cfg_t::miso
pin_name_t miso
Definition: rotaryr2.h:168
rotaryr2_cfg_t
Rotary R 2 Click configuration object.
Definition: rotaryr2.h:166
rotaryr2_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rotaryr2.h:181
ROTARYR2_ERROR
@ ROTARYR2_ERROR
Definition: rotaryr2.h:193
rotaryr2_set_led_data
err_t rotaryr2_set_led_data(rotaryr2_t *ctx, uint16_t data_in)
Rotary R 2 set LED data function.
rotaryr2_cfg_t::cs
pin_name_t cs
Definition: rotaryr2.h:171