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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
60 #define SOLIDSWITCH3_CH_OUT1 0x01
61 #define SOLIDSWITCH3_CH_OUT2 0x02
62 #define SOLIDSWITCH3_CH_OUT3 0x04
63 #define SOLIDSWITCH3_CH_OUT4 0x08
64 #define SOLIDSWITCH3_CH_OUT5 0x10
65 #define SOLIDSWITCH3_CH_OUT6 0x20
66 #define SOLIDSWITCH3_CH_OUT7 0x40
67 #define SOLIDSWITCH3_CH_OUT8 0x80
68 #define SOLIDSWITCH3_ALL_CHANNELS 0xFF
69 
74 #define SOLIDSWITCH3_DIR_MODE_SPI 0
75 #define SOLIDSWITCH3_DIR_MODE_GPIO 1
76 
81 #define SOLIDSWITCH3_OUT_DISABLE 0u
82 #define SOLIDSWITCH3_OUT_IN_TERMINAL 1u
83 #define SOLIDSWITCH3_OUT_ENABLE 2u
84 #define SOLIDSWITCH3_OUT_BITS_MASK 3u
85 
94 #define SOLIDSWITCH3_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
95 #define SOLIDSWITCH3_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
96  // solidswitch3_set
98 
113 #define SOLIDSWITCH3_MAP_MIKROBUS( cfg, mikrobus ) \
114  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
115  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
116  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
117  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
118  cfg.dir = MIKROBUS( mikrobus, MIKROBUS_AN ); \
119  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
120  cfg.in1 = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
121  cfg.in2 = MIKROBUS( mikrobus, MIKROBUS_INT )
122  // solidswitch3_map // solidswitch3
125 
130 typedef struct
131 {
132  // Output pins
133  digital_out_t dir;
134  digital_out_t rst;
135  digital_out_t in1;
136  digital_out_t in2;
138  // Modules
139  spi_master_t spi;
141  pin_name_t chip_select;
143  uint16_t output_state;
146 
151 typedef struct
152 {
153  // Communication gpio pins
154  pin_name_t miso;
155  pin_name_t mosi;
156  pin_name_t sck;
157  pin_name_t cs;
159  // Additional gpio pins
160  pin_name_t dir;
161  pin_name_t rst;
162  pin_name_t in1;
163  pin_name_t in2;
165  // static variable
166  uint32_t spi_speed;
167  spi_master_mode_t spi_mode;
168  spi_master_chip_select_polarity_t cs_polarity;
171 
176 typedef enum
177 {
179  SOLIDSWITCH3_ERROR = -1
180 
182 
199 
215 
230 
244 err_t solidswitch3_write_data ( solidswitch3_t *ctx, uint16_t data_in );
245 
258 err_t solidswitch3_enable_output ( solidswitch3_t *ctx, uint8_t channel );
259 
272 err_t solidswitch3_disable_output ( solidswitch3_t *ctx, uint8_t channel );
273 
283 
297 void solidswitch3_set_dir_mode ( solidswitch3_t *ctx, uint8_t dir_mode );
298 
308 void solidswitch3_set_rst_pin ( solidswitch3_t *ctx, uint8_t state );
309 
319 void solidswitch3_set_in1_pin ( solidswitch3_t *ctx, uint8_t state );
320 
330 void solidswitch3_set_in2_pin ( solidswitch3_t *ctx, uint8_t state );
331 
332 #ifdef __cplusplus
333 }
334 #endif
335 #endif // SOLIDSWITCH3_H
336  // solidswitch3
338 
339 // ------------------------------------------------------------------------ END
solidswitch3_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: solidswitch3.h:168
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:139
solidswitch3_cfg_t::in1
pin_name_t in1
Definition: solidswitch3.h:162
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:178
solidswitch3_cfg_t
SolidSwitch 3 Click configuration object.
Definition: solidswitch3.h:152
solidswitch3_t::dir
digital_out_t dir
Definition: solidswitch3.h:133
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:163
SOLIDSWITCH3_ERROR
@ SOLIDSWITCH3_ERROR
Definition: solidswitch3.h:179
solidswitch3_cfg_t::miso
pin_name_t miso
Definition: solidswitch3.h:154
solidswitch3_t::output_state
uint16_t output_state
Definition: solidswitch3.h:143
solidswitch3_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: solidswitch3.h:167
solidswitch3_t::rst
digital_out_t rst
Definition: solidswitch3.h:134
solidswitch3_cfg_t::sck
pin_name_t sck
Definition: solidswitch3.h:156
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:177
solidswitch3_t::in2
digital_out_t in2
Definition: solidswitch3.h:136
solidswitch3_t::chip_select
pin_name_t chip_select
Definition: solidswitch3.h:141
solidswitch3_cfg_t::mosi
pin_name_t mosi
Definition: solidswitch3.h:155
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:157
solidswitch3_t
SolidSwitch 3 Click context object.
Definition: solidswitch3.h:131
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:160
solidswitch3_cfg_t::spi_speed
uint32_t spi_speed
Definition: solidswitch3.h:166
solidswitch3_t::in1
digital_out_t in1
Definition: solidswitch3.h:135
solidswitch3_cfg_t::rst
pin_name_t rst
Definition: solidswitch3.h:161