solidswitch3  2.0.0.0
solidswitch3.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 SOLIDSWITCH3_H
29 #define SOLIDSWITCH3_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 
70 #define SOLIDSWITCH3_CH_OUT1 0x01
71 #define SOLIDSWITCH3_CH_OUT2 0x02
72 #define SOLIDSWITCH3_CH_OUT3 0x04
73 #define SOLIDSWITCH3_CH_OUT4 0x08
74 #define SOLIDSWITCH3_CH_OUT5 0x10
75 #define SOLIDSWITCH3_CH_OUT6 0x20
76 #define SOLIDSWITCH3_CH_OUT7 0x40
77 #define SOLIDSWITCH3_CH_OUT8 0x80
78 #define SOLIDSWITCH3_ALL_CHANNELS 0xFF
79 
84 #define SOLIDSWITCH3_DIR_MODE_SPI 0
85 #define SOLIDSWITCH3_DIR_MODE_GPIO 1
86 
91 #define SOLIDSWITCH3_OUT_DISABLE 0u
92 #define SOLIDSWITCH3_OUT_IN_TERMINAL 1u
93 #define SOLIDSWITCH3_OUT_ENABLE 2u
94 #define SOLIDSWITCH3_OUT_BITS_MASK 3u
95 
104 #define SOLIDSWITCH3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
105 #define SOLIDSWITCH3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
106  // solidswitch3_set
108 
123 #define SOLIDSWITCH3_MAP_MIKROBUS( cfg, mikrobus ) \
124  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
125  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
126  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
127  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
128  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
129  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
130  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
131  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_INT )
132  // solidswitch3_map // solidswitch3
135 
140 typedef struct
141 {
142  // Output pins
143  digital_out_t dir;
144  digital_out_t rst;
145  digital_out_t in1;
146  digital_out_t in2;
148  // Modules
149  spi_master_t spi;
151  pin_name_t chip_select;
153  uint16_t output_state;
156 
161 typedef struct
162 {
163  // Communication gpio pins
164  pin_name_t miso;
165  pin_name_t mosi;
166  pin_name_t sck;
167  pin_name_t cs;
169  // Additional gpio pins
170  pin_name_t dir;
171  pin_name_t rst;
172  pin_name_t in1;
173  pin_name_t in2;
175  // static variable
176  uint32_t spi_speed;
177  spi_master_mode_t spi_mode;
178  spi_master_chip_select_polarity_t cs_polarity;
181 
186 typedef enum
187 {
189  SOLIDSWITCH3_ERROR = -1
190 
192 
209 
225 
240 
254 err_t solidswitch3_write_data ( solidswitch3_t *ctx, uint16_t data_in );
255 
268 err_t solidswitch3_enable_output ( solidswitch3_t *ctx, uint8_t channel );
269 
282 err_t solidswitch3_disable_output ( solidswitch3_t *ctx, uint8_t channel );
283 
293 
307 void solidswitch3_set_dir_mode ( solidswitch3_t *ctx, uint8_t dir_mode );
308 
318 void solidswitch3_set_rst_pin ( solidswitch3_t *ctx, uint8_t state );
319 
329 void solidswitch3_set_in1_pin ( solidswitch3_t *ctx, uint8_t state );
330 
340 void solidswitch3_set_in2_pin ( solidswitch3_t *ctx, uint8_t state );
341 
342 #ifdef __cplusplus
343 }
344 #endif
345 #endif // SOLIDSWITCH3_H
346  // solidswitch3
348 
349 // ------------------------------------------------------------------------ END
solidswitch3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: solidswitch3.h:178
solidswitch3_set_in1_pin
void solidswitch3_set_in1_pin(solidswitch3_t *ctx, uint8_t state)
SolidSwitch 3 set in1 pin function.
solidswitch3_set_rst_pin
void solidswitch3_set_rst_pin(solidswitch3_t *ctx, uint8_t state)
SolidSwitch 3 set rst pin function.
spi_specifics.h
This file contains SPI specific macros, functions, etc.
solidswitch3_t::spi
spi_master_t spi
Definition: solidswitch3.h:149
solidswitch3_cfg_t::in1
pin_name_t in1
Definition: solidswitch3.h:172
solidswitch3_set_dir_mode
void solidswitch3_set_dir_mode(solidswitch3_t *ctx, uint8_t dir_mode)
SolidSwitch 3 set dir mode function.
SOLIDSWITCH3_OK
@ SOLIDSWITCH3_OK
Definition: solidswitch3.h:188
solidswitch3_cfg_t
SolidSwitch 3 Click configuration object.
Definition: solidswitch3.h:162
solidswitch3_t::dir
digital_out_t dir
Definition: solidswitch3.h:143
solidswitch3_default_cfg
err_t solidswitch3_default_cfg(solidswitch3_t *ctx)
SolidSwitch 3 default configuration function.
solidswitch3_cfg_t::in2
pin_name_t in2
Definition: solidswitch3.h:173
SOLIDSWITCH3_ERROR
@ SOLIDSWITCH3_ERROR
Definition: solidswitch3.h:189
solidswitch3_cfg_t::miso
pin_name_t miso
Definition: solidswitch3.h:164
solidswitch3_t::output_state
uint16_t output_state
Definition: solidswitch3.h:153
solidswitch3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: solidswitch3.h:177
solidswitch3_t::rst
digital_out_t rst
Definition: solidswitch3.h:144
solidswitch3_cfg_t::sck
pin_name_t sck
Definition: solidswitch3.h:166
solidswitch3_reset
void solidswitch3_reset(solidswitch3_t *ctx)
SolidSwitch 3 reset function.
solidswitch3_init
err_t solidswitch3_init(solidswitch3_t *ctx, solidswitch3_cfg_t *cfg)
SolidSwitch 3 initialization function.
solidswitch3_cfg_setup
void solidswitch3_cfg_setup(solidswitch3_cfg_t *cfg)
SolidSwitch 3 configuration object setup function.
solidswitch3_enable_output
err_t solidswitch3_enable_output(solidswitch3_t *ctx, uint8_t channel)
SolidSwitch 3 enable output function.
solidswitch3_return_value_t
solidswitch3_return_value_t
SolidSwitch 3 Click return value data.
Definition: solidswitch3.h:187
solidswitch3_t::in2
digital_out_t in2
Definition: solidswitch3.h:146
solidswitch3_t::chip_select
pin_name_t chip_select
Definition: solidswitch3.h:151
solidswitch3_cfg_t::mosi
pin_name_t mosi
Definition: solidswitch3.h:165
solidswitch3_set_in2_pin
void solidswitch3_set_in2_pin(solidswitch3_t *ctx, uint8_t state)
SolidSwitch 3 set in2 pin function.
solidswitch3_disable_output
err_t solidswitch3_disable_output(solidswitch3_t *ctx, uint8_t channel)
SolidSwitch 3 disable output function.
solidswitch3_cfg_t::cs
pin_name_t cs
Definition: solidswitch3.h:167
solidswitch3_t
SolidSwitch 3 Click context object.
Definition: solidswitch3.h:141
solidswitch3_write_data
err_t solidswitch3_write_data(solidswitch3_t *ctx, uint16_t data_in)
SolidSwitch 3 write data function.
solidswitch3_cfg_t::dir
pin_name_t dir
Definition: solidswitch3.h:170
solidswitch3_cfg_t::spi_speed
uint32_t spi_speed
Definition: solidswitch3.h:176
solidswitch3_t::in1
digital_out_t in1
Definition: solidswitch3.h:145
solidswitch3_cfg_t::rst
pin_name_t rst
Definition: solidswitch3.h:171