rotaryr  2.0.0.0
rotaryr.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 ROTARYR_H
29 #define ROTARYR_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 
64 #define ROTARYR_ONE_LED 0x0001
65 #define ROTARYR_TWO_LED 0x0101
66 #define ROTARYR_FOUR_LED 0x1111
67 #define ROTARYR_EIGHT_LED 0x5555
68 #define ROTARYR_RESET_LED 0x0000
69  // rotaryr_led
71 
86 #define ROTARYR_MAP_MIKROBUS( cfg, mikrobus ) \
87  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
88  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
89  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
90  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
91  cfg.ecb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
92  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
93  cfg.eca = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
94  cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
95  // rotaryr_map // rotaryr
98 
103 typedef struct
104 {
105  // Output pins
106 
107  digital_out_t rst;
108  digital_out_t cs;
109 
110  // Input pins
111 
112  digital_in_t ecb;
113  digital_in_t eca;
114  digital_in_t sw;
115 
116  // Modules
117 
118  spi_master_t spi;
120  pin_name_t chip_select;
122 } rotaryr_t;
123 
128 typedef struct
129 {
130  // Communication gpio pins
131 
132  pin_name_t miso;
133  pin_name_t mosi;
134  pin_name_t sck;
135  pin_name_t cs;
137  // Additional gpio pins
138 
139  pin_name_t ecb;
140  pin_name_t rst;
141  pin_name_t eca;
142  pin_name_t sw;
143 
144  // static variable
145 
146  uint32_t spi_speed;
147  spi_master_mode_t spi_mode;
148  spi_master_chip_select_polarity_t cs_polarity;
150 } rotaryr_cfg_t;
151 
156 typedef enum
157 {
159  ROTARYR_ERROR = -1
160 
162 
179 
194 err_t rotaryr_init ( rotaryr_t *ctx, rotaryr_cfg_t *cfg );
195 
210 void rotaryr_generic_transfer ( rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
211 
222 void rotaryr_turn_on_led_by_data ( rotaryr_t *ctx, uint16_t write_data );
223 
234 void rotaryr_turn_on_led_by_position ( rotaryr_t *ctx, uint8_t led_position );
235 
247 
256 uint16_t rotaryr_get_led_data ( uint8_t current_led_state );
257 
268 
279 
290 
291 #ifdef __cplusplus
292 }
293 #endif
294 #endif // ROTARYR_H
295  // rotaryr
297 
298 // ------------------------------------------------------------------------ END
rotaryr_button_push
uint8_t rotaryr_button_push(rotaryr_t *ctx)
Button push state.
rotaryr_cfg_setup
void rotaryr_cfg_setup(rotaryr_cfg_t *cfg)
ROTARY R configuration object setup function.
rotaryr_get_led_data
uint16_t rotaryr_get_led_data(uint8_t current_led_state)
Get led data state.
rotaryr_cfg_t::rst
pin_name_t rst
Definition: rotaryr.h:140
ROTARYR_ERROR
@ ROTARYR_ERROR
Definition: rotaryr.h:159
rotaryr_t::cs
digital_out_t cs
Definition: rotaryr.h:108
rotaryr_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rotaryr.h:147
rotaryr_cfg_t::mosi
pin_name_t mosi
Definition: rotaryr.h:133
rotaryr_t::eca
digital_in_t eca
Definition: rotaryr.h:113
ROTARYR_OK
@ ROTARYR_OK
Definition: rotaryr.h:158
rotaryr_cfg_t
ROTARY R Click configuration object.
Definition: rotaryr.h:129
rotaryr_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rotaryr.h:148
rotaryr_cfg_t::spi_speed
uint32_t spi_speed
Definition: rotaryr.h:146
rotaryr_t
ROTARY R Click context object.
Definition: rotaryr.h:104
rotaryr_cfg_t::ecb
pin_name_t ecb
Definition: rotaryr.h:139
rotaryr_cfg_t::cs
pin_name_t cs
Definition: rotaryr.h:135
rotaryr_cfg_t::sck
pin_name_t sck
Definition: rotaryr.h:134
rotaryr_reset_led
void rotaryr_reset_led(rotaryr_t *ctx)
Reset led.
rotaryr_cfg_t::eca
pin_name_t eca
Definition: rotaryr.h:141
rotaryr_return_value_t
rotaryr_return_value_t
ROTARY R Click return value data.
Definition: rotaryr.h:157
rotaryr_t::spi
spi_master_t spi
Definition: rotaryr.h:118
rotaryr_turn_on_led_by_position
void rotaryr_turn_on_led_by_position(rotaryr_t *ctx, uint8_t led_position)
ROTARY R turn on led by position function.
rotaryr_t::chip_select
pin_name_t chip_select
Definition: rotaryr.h:120
rotaryr_cfg_t::miso
pin_name_t miso
Definition: rotaryr.h:132
rotaryr_cfg_t::sw
pin_name_t sw
Definition: rotaryr.h:142
rotaryr_t::ecb
digital_in_t ecb
Definition: rotaryr.h:112
rotaryr_init
err_t rotaryr_init(rotaryr_t *ctx, rotaryr_cfg_t *cfg)
ROTARY R initialization function.
rotaryr_t::sw
digital_in_t sw
Definition: rotaryr.h:114
rotaryr_get_ecb_state
uint8_t rotaryr_get_ecb_state(rotaryr_t *ctx)
State ecb pin.
rotaryr_get_eca_state
uint8_t rotaryr_get_eca_state(rotaryr_t *ctx)
State eca pin.
rotaryr_t::rst
digital_out_t rst
Definition: rotaryr.h:107
rotaryr_generic_transfer
void rotaryr_generic_transfer(rotaryr_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
ROTARY R data transfer function.
rotaryr_turn_on_led_by_data
void rotaryr_turn_on_led_by_data(rotaryr_t *ctx, uint16_t write_data)
ROTARY R generic data write function.