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 "drv_digital_out.h"
36 #include "drv_digital_in.h"
37 #include "drv_spi_master.h"
38 #include "spi_specifics.h"
39 
64 #define CURRENTLIMIT6_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
65 #define CURRENTLIMIT6_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
66  // currentlimit6_set
68 
83 #define CURRENTLIMIT6_MAP_MIKROBUS( cfg, mikrobus ) \
84  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
85  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
86  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
87  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
88  cfg.er2 = MIKROBUS( mikrobus, MIKROBUS_AN ); \
89  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
90  cfg.er1 = MIKROBUS( mikrobus, MIKROBUS_INT )
91  // currentlimit6_map // currentlimit6
94 
99 typedef struct
100 {
101  // Output pins
102  digital_out_t en;
104  // Input pins
105  digital_in_t er2;
106  digital_in_t er1;
108  // Modules
109  spi_master_t spi;
111  pin_name_t chip_select;
114 
119 typedef struct
120 {
121  // Communication gpio pins
122  pin_name_t miso;
123  pin_name_t mosi;
124  pin_name_t sck;
125  pin_name_t cs;
127  // Additional gpio pins
128  pin_name_t er2;
129  pin_name_t en;
130  pin_name_t er1;
132  // static variable
133  uint32_t spi_speed;
134  spi_master_mode_t spi_mode;
135  spi_master_chip_select_polarity_t cs_polarity;
138 
143 typedef enum
144 {
147 
149 
154 typedef enum
155 {
158 
160 
177 
193 
208 
226 
240 err_t currentlimit6_generic_write ( currentlimit6_t *ctx, uint8_t data_in );
241 
256 err_t currentlimit6_set_current_limit ( currentlimit6_t *ctx, float current_limit );
257 
273 
289 
290 #ifdef __cplusplus
291 }
292 #endif
293 #endif // CURRENTLIMIT6_H
294  // currentlimit6
296 
297 // ------------------------------------------------------------------------ END
currentlimit6_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: currentlimit6.h:135
currentlimit6_cfg_t::er2
pin_name_t er2
Definition: currentlimit6.h:128
spi_specifics.h
This file contains SPI specific macros, functions, etc.
currentlimit6_cfg_t::sck
pin_name_t sck
Definition: currentlimit6.h:124
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:144
currentlimit6_cfg_t::en
pin_name_t en
Definition: currentlimit6.h:129
CURRENTLIMIT6_PWR_ON
@ CURRENTLIMIT6_PWR_ON
Definition: currentlimit6.h:157
currentlimit6_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: currentlimit6.h:134
CURRENTLIMIT6_PWR_OFF
@ CURRENTLIMIT6_PWR_OFF
Definition: currentlimit6.h:156
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:146
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:123
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:102
currentlimit6_t::chip_select
pin_name_t chip_select
Definition: currentlimit6.h:111
currentlimit6_cfg_t::miso
pin_name_t miso
Definition: currentlimit6.h:122
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:155
currentlimit6_cfg_t
Current Limit 6 Click configuration object.
Definition: currentlimit6.h:120
currentlimit6_t::er1
digital_in_t er1
Definition: currentlimit6.h:106
currentlimit6_cfg_t::cs
pin_name_t cs
Definition: currentlimit6.h:125
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:133
currentlimit6_cfg_t::er1
pin_name_t er1
Definition: currentlimit6.h:130
CURRENTLIMIT6_OK
@ CURRENTLIMIT6_OK
Definition: currentlimit6.h:145
currentlimit6_t::spi
spi_master_t spi
Definition: currentlimit6.h:109
currentlimit6_t
Current Limit 6 Click context object.
Definition: currentlimit6.h:100
currentlimit6_t::er2
digital_in_t er2
Definition: currentlimit6.h:105