rotaryg  2.0.0.0
rotaryg.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 ROTARYG_H
29 #define ROTARYG_H
30 
31 #ifdef __cplusplus
32 extern "C"{
33 #endif
34 
39 #ifdef PREINIT_SUPPORTED
40 #include "preinit.h"
41 #endif
42 
43 #ifdef MikroCCoreVersion
44  #if MikroCCoreVersion >= 1
45  #include "delays.h"
46  #endif
47 #endif
48 
49 #include "drv_digital_out.h"
50 #include "drv_digital_in.h"
51 #include "drv_spi_master.h"
52 
68 #define ROTARYG_ONE_LED 0x0001
69 #define ROTARYG_TWO_LED 0x0101
70 #define ROTARYG_FOUR_LED 0x1111
71 #define ROTARYG_EIGHT_LED 0x5555
72 #define ROTARYG_RESET_LED 0x0000
73  // rotaryg_led
75 
90 #define ROTARYG_MAP_MIKROBUS( cfg, mikrobus ) \
91  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
92  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
93  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
94  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
95  cfg.ecb = MIKROBUS( mikrobus, MIKROBUS_AN ); \
96  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
97  cfg.eca = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
98  cfg.sw = MIKROBUS( mikrobus, MIKROBUS_INT )
99  // rotaryg_map // rotaryg
102 
107 typedef struct
108 {
109  // Output pins
110 
111  digital_out_t rst;
112  digital_out_t cs;
113 
114  // Input pins
115 
116  digital_in_t ecb;
117  digital_in_t eca;
118  digital_in_t sw;
119 
120  // Modules
121 
122  spi_master_t spi;
124  pin_name_t chip_select;
126 } rotaryg_t;
127 
132 typedef struct
133 {
134  // Communication gpio pins
135 
136  pin_name_t miso;
137  pin_name_t mosi;
138  pin_name_t sck;
139  pin_name_t cs;
141  // Additional gpio pins
142 
143  pin_name_t ecb;
144  pin_name_t rst;
145  pin_name_t eca;
146  pin_name_t sw;
147 
148  // static variable
149 
150  uint32_t spi_speed;
151  spi_master_mode_t spi_mode;
152  spi_master_chip_select_polarity_t cs_polarity;
154 } rotaryg_cfg_t;
155 
160 typedef enum
161 {
163  ROTARYG_ERROR = -1
164 
166 
183 
198 err_t rotaryg_init ( rotaryg_t *ctx, rotaryg_cfg_t *cfg );
199 
214 void rotaryg_generic_transfer ( rotaryg_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len );
215 
226 void rotaryg_turn_on_led_by_data ( rotaryg_t *ctx, uint16_t write_data );
227 
238 void rotaryg_turn_on_led_by_position ( rotaryg_t *ctx, uint8_t led_position );
239 
251 
260 uint16_t rotaryg_get_led_data ( uint8_t current_led_state );
261 
272 
283 
294 
295 #ifdef __cplusplus
296 }
297 #endif
298 #endif // ROTARYG_H
299  // rotaryg
301 
302 // ------------------------------------------------------------------------ END
rotaryg_return_value_t
rotaryg_return_value_t
ROTARY G Click return value data.
Definition: rotaryg.h:161
rotaryg_t::spi
spi_master_t spi
Definition: rotaryg.h:122
rotaryg_cfg_t
ROTARY G Click configuration object.
Definition: rotaryg.h:133
rotaryg_cfg_t::rst
pin_name_t rst
Definition: rotaryg.h:144
rotaryg_button_push
uint8_t rotaryg_button_push(rotaryg_t *ctx)
Button push state.
rotaryg_t::cs
digital_out_t cs
Definition: rotaryg.h:112
rotaryg_t::rst
digital_out_t rst
Definition: rotaryg.h:111
rotaryg_get_led_data
uint16_t rotaryg_get_led_data(uint8_t current_led_state)
Get led data state.
rotaryg_t::eca
digital_in_t eca
Definition: rotaryg.h:117
rotaryg_cfg_t::mosi
pin_name_t mosi
Definition: rotaryg.h:137
rotaryg_cfg_t::cs
pin_name_t cs
Definition: rotaryg.h:139
rotaryg_turn_on_led_by_data
void rotaryg_turn_on_led_by_data(rotaryg_t *ctx, uint16_t write_data)
ROTARY G generic data write function.
rotaryg_cfg_t::spi_speed
uint32_t spi_speed
Definition: rotaryg.h:150
rotaryg_t
ROTARY G Click context object.
Definition: rotaryg.h:108
rotaryg_t::chip_select
pin_name_t chip_select
Definition: rotaryg.h:124
ROTARYG_OK
@ ROTARYG_OK
Definition: rotaryg.h:162
rotaryg_turn_on_led_by_position
void rotaryg_turn_on_led_by_position(rotaryg_t *ctx, uint8_t led_position)
ROTARY G turn on led by position function.
rotaryg_cfg_t::eca
pin_name_t eca
Definition: rotaryg.h:145
rotaryg_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: rotaryg.h:151
rotaryg_generic_transfer
void rotaryg_generic_transfer(rotaryg_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
ROTARY G data transfer function.
rotaryg_get_eca_state
uint8_t rotaryg_get_eca_state(rotaryg_t *ctx)
State eca pin.
rotaryg_init
err_t rotaryg_init(rotaryg_t *ctx, rotaryg_cfg_t *cfg)
ROTARY G initialization function.
rotaryg_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: rotaryg.h:152
rotaryg_cfg_t::sw
pin_name_t sw
Definition: rotaryg.h:146
rotaryg_t::ecb
digital_in_t ecb
Definition: rotaryg.h:116
rotaryg_get_ecb_state
uint8_t rotaryg_get_ecb_state(rotaryg_t *ctx)
State ecb pin.
rotaryg_cfg_setup
void rotaryg_cfg_setup(rotaryg_cfg_t *cfg)
ROTARY G configuration object setup function.
rotaryg_cfg_t::sck
pin_name_t sck
Definition: rotaryg.h:138
rotaryg_t::sw
digital_in_t sw
Definition: rotaryg.h:118
rotaryg_reset_led
void rotaryg_reset_led(rotaryg_t *ctx)
Reset led.
rotaryg_cfg_t::miso
pin_name_t miso
Definition: rotaryg.h:136
rotaryg_cfg_t::ecb
pin_name_t ecb
Definition: rotaryg.h:143
ROTARYG_ERROR
@ ROTARYG_ERROR
Definition: rotaryg.h:163