stepdown9  2.1.0.0
stepdown9.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 STEPDOWN9_H
29 #define STEPDOWN9_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 STEPDOWN9_VOUT_10V_RESISTANCE 8700
71 #define STEPDOWN9_VOUT_9V5_RESISTANCE 11500
72 #define STEPDOWN9_VOUT_9V_RESISTANCE 11700
73 #define STEPDOWN9_VOUT_8V5_RESISTANCE 12500
74 #define STEPDOWN9_VOUT_8V_RESISTANCE 13000
75 #define STEPDOWN9_VOUT_7V5_RESISTANCE 13700
76 #define STEPDOWN9_VOUT_7V_RESISTANCE 14700
77 #define STEPDOWN9_VOUT_6V5_RESISTANCE 15800
78 #define STEPDOWN9_VOUT_6V_RESISTANCE 17000
79 #define STEPDOWN9_VOUT_5V5_RESISTANCE 19000
80 #define STEPDOWN9_VOUT_5V_RESISTANCE 21000
81 #define STEPDOWN9_VOUT_4V5_RESISTANCE 23500
82 #define STEPDOWN9_VOUT_4V_RESISTANCE 27000
83 #define STEPDOWN9_VOUT_3V5_RESISTANCE 32000
84 #define STEPDOWN9_VOUT_3V3_RESISTANCE 34000
85 #define STEPDOWN9_VOUT_3V_RESISTANCE 38000
86 #define STEPDOWN9_VOUT_2V5_RESISTANCE 50000
87 #define STEPDOWN9_VOUT_2V_RESISTANCE 70000
88 #define STEPDOWN9_VOUT_1V6_RESISTANCE 100000
89 
94 #define STEPDOWN9_VOUT_10V 0x12
95 #define STEPDOWN9_VOUT_9V5 0x11
96 #define STEPDOWN9_VOUT_9V 0x10
97 #define STEPDOWN9_VOUT_8V5 0x0F
98 #define STEPDOWN9_VOUT_8V 0x0E
99 #define STEPDOWN9_VOUT_7V5 0x0D
100 #define STEPDOWN9_VOUT_7V 0x0C
101 #define STEPDOWN9_VOUT_6V5 0x0B
102 #define STEPDOWN9_VOUT_6V 0x0A
103 #define STEPDOWN9_VOUT_5V5 0x09
104 #define STEPDOWN9_VOUT_5V 0x08
105 #define STEPDOWN9_VOUT_4V5 0x07
106 #define STEPDOWN9_VOUT_4V 0x06
107 #define STEPDOWN9_VOUT_3V5 0x05
108 #define STEPDOWN9_VOUT_3V3 0x04
109 #define STEPDOWN9_VOUT_3V 0x03
110 #define STEPDOWN9_VOUT_2V5 0x02
111 #define STEPDOWN9_VOUT_2V 0x01
112 #define STEPDOWN9_VOUT_1V6 0x00
113 
118 #define STEPDOWN9_PIN_STATE_HIGH 0x01
119 #define STEPDOWN9_PIN_STATE_LOW 0x00
120 
126 #define STEPDOWN9_RESISTANCE_MIN 8700
127 #define STEPDOWN9_FULL_SCALE_RES_100_KOHM 100000
128 #define STEPDOWN9_WIPER_POS_MAX 0xFF
129 #define STEPDOWN9_ROUND_TO_NEAREST_INT 0.5
130 
139 #define STEPDOWN9_SET_DATA_SAMPLE_EDGE SET_SPI_DATA_SAMPLE_EDGE
140 #define STEPDOWN9_SET_DATA_SAMPLE_MIDDLE SET_SPI_DATA_SAMPLE_MIDDLE
141  // stepdown9_set
143 
158 #define STEPDOWN9_MAP_MIKROBUS( cfg, mikrobus ) \
159  cfg.miso = MIKROBUS( mikrobus, MIKROBUS_MISO ); \
160  cfg.mosi = MIKROBUS( mikrobus, MIKROBUS_MOSI ); \
161  cfg.sck = MIKROBUS( mikrobus, MIKROBUS_SCK ); \
162  cfg.cs = MIKROBUS( mikrobus, MIKROBUS_CS ); \
163  cfg.en = MIKROBUS( mikrobus, MIKROBUS_PWM ); \
164  cfg.pg = MIKROBUS( mikrobus, MIKROBUS_INT )
165  // stepdown9_map // stepdown9
168 
173 typedef struct
174 {
175  // Output pins
176  digital_out_t en;
178  // Input pins
179  digital_in_t pg;
181  // Modules
182  spi_master_t spi;
184  pin_name_t chip_select;
186 } stepdown9_t;
187 
192 typedef struct
193 {
194  // Communication gpio pins
195  pin_name_t miso;
196  pin_name_t mosi;
197  pin_name_t sck;
198  pin_name_t cs;
200  // Additional gpio pins
201  pin_name_t en;
202  pin_name_t pg;
204  // static variable
205  uint32_t spi_speed;
206  spi_master_mode_t spi_mode;
207  spi_master_chip_select_polarity_t cs_polarity;
210 
215 typedef enum
216 {
218  STEPDOWN9_ERROR = -1
219 
221 
238 
253 
267 
282 err_t stepdown9_generic_write ( stepdown9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len );
283 
298 err_t stepdown9_generic_read ( stepdown9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len );
299 
309 void stepdown9_set_en_pin ( stepdown9_t *ctx, uint8_t pin_state );
310 
320 
332 err_t stepdown9_set_wiper_pos ( stepdown9_t *ctx, uint8_t wiper_pos );
333 
345 err_t stepdown9_set_resistance ( stepdown9_t *ctx, uint32_t res_ohm );
346 
358 err_t stepdown9_set_output ( stepdown9_t *ctx, uint8_t voltage );
359 
360 #ifdef __cplusplus
361 }
362 #endif
363 #endif // STEPDOWN9_H
364  // stepdown9
366 
367 // ------------------------------------------------------------------------ END
stepdown9_set_resistance
err_t stepdown9_set_resistance(stepdown9_t *ctx, uint32_t res_ohm)
Step Down 9 set potentiometer resistance.
stepdown9_t::pg
digital_in_t pg
Definition: stepdown9.h:179
stepdown9_set_wiper_pos
err_t stepdown9_set_wiper_pos(stepdown9_t *ctx, uint8_t wiper_pos)
Step Down 9 set wiper position.
stepdown9_t
Step Down 9 Click context object.
Definition: stepdown9.h:174
stepdown9_t::chip_select
pin_name_t chip_select
Definition: stepdown9.h:184
stepdown9_cfg_t::en
pin_name_t en
Definition: stepdown9.h:201
spi_specifics.h
This file contains SPI specific macros, functions, etc.
STEPDOWN9_ERROR
@ STEPDOWN9_ERROR
Definition: stepdown9.h:218
stepdown9_cfg_t::spi_speed
uint32_t spi_speed
Definition: stepdown9.h:205
stepdown9_get_pg_pin
uint8_t stepdown9_get_pg_pin(stepdown9_t *ctx)
Step Down 9 get PG pin state function.
STEPDOWN9_OK
@ STEPDOWN9_OK
Definition: stepdown9.h:217
stepdown9_cfg_t
Step Down 9 Click configuration object.
Definition: stepdown9.h:193
stepdown9_set_en_pin
void stepdown9_set_en_pin(stepdown9_t *ctx, uint8_t pin_state)
Step Down 9 set EN pin state function.
stepdown9_return_value_t
stepdown9_return_value_t
Step Down 9 Click return value data.
Definition: stepdown9.h:216
stepdown9_cfg_t::mosi
pin_name_t mosi
Definition: stepdown9.h:196
stepdown9_cfg_setup
void stepdown9_cfg_setup(stepdown9_cfg_t *cfg)
Step Down 9 configuration object setup function.
stepdown9_generic_write
err_t stepdown9_generic_write(stepdown9_t *ctx, uint8_t reg, uint8_t *data_in, uint8_t len)
Step Down 9 data writing function.
stepdown9_cfg_t::pg
pin_name_t pg
Definition: stepdown9.h:202
stepdown9_set_output
err_t stepdown9_set_output(stepdown9_t *ctx, uint8_t voltage)
Step Down 9 set output voltage.
stepdown9_cfg_t::cs
pin_name_t cs
Definition: stepdown9.h:198
stepdown9_cfg_t::spi_mode
spi_master_mode_t spi_mode
Definition: stepdown9.h:206
stepdown9_cfg_t::cs_polarity
spi_master_chip_select_polarity_t cs_polarity
Definition: stepdown9.h:207
stepdown9_default_cfg
err_t stepdown9_default_cfg(stepdown9_t *ctx)
Step Down 9 default configuration function.
stepdown9_t::spi
spi_master_t spi
Definition: stepdown9.h:182
stepdown9_init
err_t stepdown9_init(stepdown9_t *ctx, stepdown9_cfg_t *cfg)
Step Down 9 initialization function.
stepdown9_cfg_t::sck
pin_name_t sck
Definition: stepdown9.h:197
stepdown9_t::en
digital_out_t en
Definition: stepdown9.h:176
stepdown9_generic_read
err_t stepdown9_generic_read(stepdown9_t *ctx, uint8_t reg, uint8_t *data_out, uint8_t len)
Step Down 9 data reading function.
stepdown9_cfg_t::miso
pin_name_t miso
Definition: stepdown9.h:195