currentlimit6  2.0.0.0
currentlimit6.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 CURRENTLIMIT6_H
29 #define CURRENTLIMIT6_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 
74 #define CURRENTLIMIT6_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
75 #define CURRENTLIMIT6_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
76  // currentlimit6_set
78 
93 #define CURRENTLIMIT6_MAP_MIKROBUS( cfg, mikrobus ) \
94  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
95  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
96  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
97  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
98  cfg.er2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
99  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
100  cfg.er1 = MIKROBUS( mikrobus, MIKROBUS_INT )
101  // currentlimit6_map // currentlimit6
104 
109 typedef struct
110 {
111  // Output pins
112  digital_out_t en;
114  // Input pins
115  digital_in_t er2;
116  digital_in_t er1;
118  // Modules
119  spi_master_t spi;
121  pin_name_t chip_select;
124 
129 typedef struct
130 {
131  // Communication gpio pins
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  pin_name_t er2;
139  pin_name_t en;
140  pin_name_t er1;
142  // static variable
143  uint32_t spi_speed;
144  spi_master_mode_t spi_mode;
145  spi_master_chip_select_polarity_t cs_polarity;
148 
153 typedef enum
154 {
157 
159 
164 typedef enum
165 {
168 
170 
187 
203 
218 
236 
250 err_t currentlimit6_generic_write ( currentlimit6_t *ctx, uint8_t data_in );
251 
266 err_t currentlimit6_set_current_limit ( currentlimit6_t *ctx, float current_limit );
267 
283 
299 
300 #ifdef __cplusplus
301 }
302 #endif
303 #endif // CURRENTLIMIT6_H
304  // currentlimit6
306 
307 // ------------------------------------------------------------------------ END
currentlimit6_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: currentlimit6.h:145
currentlimit6_cfg_t::er2
pin_name_t er2
Definition: currentlimit6.h:138
spi_specifics.h
This file contains SPI specific macros, functions, etc.
currentlimit6_cfg_t::sck
pin_name_t sck
Definition: currentlimit6.h:134
currentlimit6_set_current_limit
err_t currentlimit6_set_current_limit(currentlimit6_t *ctx, float current_limit)
Current Limit 6 set current limit function.
currentlimit6_return_value_t
currentlimit6_return_value_t
Current Limit 6 Click return value data.
Definition: currentlimit6.h:154
currentlimit6_cfg_t::en
pin_name_t en
Definition: currentlimit6.h:139
CURRENTLIMIT6_PWR_ON
@ CURRENTLIMIT6_PWR_ON
Definition: currentlimit6.h:167
currentlimit6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: currentlimit6.h:144
CURRENTLIMIT6_PWR_OFF
@ CURRENTLIMIT6_PWR_OFF
Definition: currentlimit6.h:166
currentlimit6_check_limit_exceeded
uint8_t currentlimit6_check_limit_exceeded(currentlimit6_t *ctx)
Current Limit 6 check limit exceeded function.
currentlimit6_check_voltage_err
uint8_t currentlimit6_check_voltage_err(currentlimit6_t *ctx)
Current Limit 6 check voltage error function.
CURRENTLIMIT6_ERROR
@ CURRENTLIMIT6_ERROR
Definition: currentlimit6.h:156
currentlimit6_generic_write
err_t currentlimit6_generic_write(currentlimit6_t *ctx, uint8_t data_in)
Current Limit 6 data writing function.
currentlimit6_init
err_t currentlimit6_init(currentlimit6_t *ctx, currentlimit6_cfg_t *cfg)
Current Limit 6 initialization function.
currentlimit6_cfg_t::mosi
pin_name_t mosi
Definition: currentlimit6.h:133
currentlimit6_default_cfg
err_t currentlimit6_default_cfg(currentlimit6_t *ctx)
Current Limit 6 default configuration function.
currentlimit6_t::en
digital_out_t en
Definition: currentlimit6.h:112
currentlimit6_t::chip_select
pin_name_t chip_select
Definition: currentlimit6.h:121
currentlimit6_cfg_t::miso
pin_name_t miso
Definition: currentlimit6.h:132
currentlimit6_power_mode
err_t currentlimit6_power_mode(currentlimit6_t *ctx, currentlimit6_pwr_mode_value_t pwr_mode)
Current Limit 6 power mode function.
currentlimit6_pwr_mode_value_t
currentlimit6_pwr_mode_value_t
Current Limit 6 Click power mode data.
Definition: currentlimit6.h:165
currentlimit6_cfg_t
Current Limit 6 Click configuration object.
Definition: currentlimit6.h:130
currentlimit6_t::er1
digital_in_t er1
Definition: currentlimit6.h:116
currentlimit6_cfg_t::cs
pin_name_t cs
Definition: currentlimit6.h:135
currentlimit6_cfg_setup
void currentlimit6_cfg_setup(currentlimit6_cfg_t *cfg)
Current Limit 6 configuration object setup function.
currentlimit6_cfg_t::spi_speed
uint32_t spi_speed
Definition: currentlimit6.h:143
currentlimit6_cfg_t::er1
pin_name_t er1
Definition: currentlimit6.h:140
CURRENTLIMIT6_OK
@ CURRENTLIMIT6_OK
Definition: currentlimit6.h:155
currentlimit6_t::spi
spi_master_t spi
Definition: currentlimit6.h:119
currentlimit6_t
Current Limit 6 Click context object.
Definition: currentlimit6.h:110
currentlimit6_t::er2
digital_in_t er2
Definition: currentlimit6.h:115