pwm  2.0.0.0
pwm.h
Go to the documentation of this file.
1 /*
2  * MikroSDK - MikroE Software Development Kit
3  * Copyright© 2020 MikroElektronika d.o.o.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without restriction,
8  * including without limitation the rights to use, copy, modify, merge,
9  * publish, distribute, sublicense, and/or sell copies of the Software,
10  * and to permit persons to whom the Software is furnished to do so,
11  * subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
19  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
22  * OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
33 // ----------------------------------------------------------------------------
34 
35 #ifndef PWM_H
36 #define PWM_H
37 
38 #include "drv_digital_out.h"
39 #include "drv_i2c_master.h"
40 
41 // -------------------------------------------------------------- PUBLIC MACROS
51 #define PWM_MAP_MIKROBUS( cfg, mikrobus ) \
52  cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
53  cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
54  cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST );
55 
61 #define PWM_MAX_RESOLUTION 4096
62 
68 #define PWM_RETVAL uint8_t
69 #define PWM_OK 0x00
70 #define PWM_INIT_ERROR 0xFF
71  // End group macro
74 
75  // -------------------------------------------------------------- PRIVATE MACROS
85 #define PWM_DISABLE 0x00
86 #define PWM_ENABLE 0x01
87 
93 #define PWM_RESTART 0x80
94 #define PWM_EXTCLK 0x40
95 #define PWM_AI 0x20
96 #define PWM_SLEEP 0x10
97 #define PWM_SUB_1 0x08
98 #define PWM_SUB_2 0x04
99 #define PWM_SUB_3 0x02
100 #define PWM_ALL_CALL 0x01
101 
107 #define PWM_INVRT 0x10
108 #define PWM_OCH 0x08
109 #define PWM_OUTDRV 0x04
110 #define PWM_OUTNE1 0x02
111 #define PWM_OUTNE0 0x01
112 
118 #define PWM_I2C_ADDRESS 0x40
119 
125 #define PWM_MODE1_REG 0x00
126 
132 #define PWM_MODE2_REG 0x01
133 
139 #define PWM_PRE_SCALE 0xFE
140 
146 #define PWM_TEST 0xFF
147 
153 #define PWM_CH0_ON_L 0x06
154 #define PWM_CH0_ON_H 0x07
155 #define PWM_CH0_OFF_L 0x08
156 #define PWM_CH0_OFF_H 0x09
157 
163 #define PWM_CH1_ON_L 0x0A
164 #define PWM_CH1_ON_H 0x0B
165 #define PWM_CH1_OFF_L 0x0C
166 #define PWM_CH1_OFF_H 0x0D
167 
173 #define PWM_CH2_ON_L 0x0E
174 #define PWM_CH2_ON_H 0x0F
175 #define PWM_CH2_OFF_L 0x10
176 #define PWM_CH2_OFF_H 0x11
177 
183 #define PWM_CH3_ON_L 0x12
184 #define PWM_CH3_ON_H 0x13
185 #define PWM_CH3_OFF_L 0x14
186 #define PWM_CH3_OFF_H 0x15
187 
193 #define PWM_CH4_ON_L 0x16
194 #define PWM_CH4_ON_H 0x17
195 #define PWM_CH4_OFF_L 0x18
196 #define PWM_CH4_OFF_H 0x19
197 
203 #define PWM_CH5_ON_L 0x1A
204 #define PWM_CH5_ON_H 0x1B
205 #define PWM_CH5_OFF_L 0x1C
206 #define PWM_CH5_OFF_H 0x1D
207 
213 #define PWM_CH6_ON_L 0x1E
214 #define PWM_CH6_ON_H 0x1F
215 #define PWM_CH6_OFF_L 0x20
216 #define PWM_CH6_OFF_H 0x21
217 
223 #define PWM_CH7_ON_L 0x22
224 #define PWM_CH7_ON_H 0x23
225 #define PWM_CH7_OFF_L 0x24
226 #define PWM_CH7_OFF_H 0x25
227 
233 #define PWM_CH8_ON_L 0x26
234 #define PWM_CH8_ON_H 0x27
235 #define PWM_CH8_OFF_L 0x28
236 #define PWM_CH8_OFF_H 0x29
237 
243 #define PWM_CH9_ON_L 0x2A
244 #define PWM_CH9_ON_H 0x2B
245 #define PWM_CH9_OFF_L 0x2C
246 #define PWM_CH9_OFF_H 0x2D
247 
253 #define PWM_CH10_ON_L 0x2E
254 #define PWM_CH10_ON_H 0x2F
255 #define PWM_CH10_OFF_L 0x30
256 #define PWM_CH10_OFF_H 0x31
257 
263 #define PWM_CH11_ON_L 0x32
264 #define PWM_CH11_ON_H 0x33
265 #define PWM_CH11_OFF_L 0x34
266 #define PWM_CH11_OFF_H 0x35
267 
273 #define PWM_CH12_ON_L 0x36
274 #define PWM_CH12_ON_H 0x37
275 #define PWM_CH12_OFF_L 0x38
276 #define PWM_CH12_OFF_H 0x39
277 
283 #define PWM_CH13_ON_L 0x3A
284 #define PWM_CH13_ON_H 0x3B
285 #define PWM_CH13_OFF_L 0x3C
286 #define PWM_CH13_OFF_H 0x3D
287 
293 #define PWM_CH14_ON_L 0x3E
294 #define PWM_CH14_ON_H 0x3F
295 #define PWM_CH14_OFF_L 0x40
296 #define PWM_CH14_OFF_H 0x41
297 
303 #define PWM_CH15_ON_L 0x42
304 #define PWM_CH15_ON_H 0x43
305 #define PWM_CH15_OFF_L 0x44
306 #define PWM_CH15_OFF_H 0x45
307 
313 #define PWM_ALL_CH_ON_L 0xFA
314 #define PWM_ALL_CH_ON_H 0xFB
315 #define PWM_ALL_CH_OFF_L 0xFC
316 #define PWM_ALL_CH_OFF_H 0xFD
317  // End group macro
320 // --------------------------------------------------------------- PUBLIC TYPES
329 typedef struct
330 {
331  // Output pins
332 
333  digital_out_t rst;
334 
335  // Modules
336 
337  i2c_master_t i2c;
338 
339  // ctx variable
340 
341  uint8_t slave_address;
342 
343 } pwm_t;
344 
348 typedef struct
349 {
350  // Communication gpio pins
351 
352  pin_name_t scl;
353  pin_name_t sda;
354 
355  // Additional gpio pins
356 
357  pin_name_t rst;
358 
359  // static variable
360 
361  uint32_t i2c_speed;
362  uint8_t i2c_address;
363 
364 } pwm_cfg_t;
365  // End types group
367 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
368 
374 #ifdef __cplusplus
375 extern "C"{
376 #endif
377 
386 void pwm_cfg_setup ( pwm_cfg_t *cfg );
387 
396 PWM_RETVAL pwm_init ( pwm_t *ctx, pwm_cfg_t *cfg );
397 
408 void pwm_generic_write ( pwm_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
409 
420 void pwm_generic_read ( pwm_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len );
421 
422 
431 void pwm_set_output ( pwm_t *ctx, uint8_t en_ou );
432 
458 void pwm_dev_config ( pwm_t *ctx, uint8_t *config );
459 
480 void pwm_output_config ( pwm_t *ctx, uint8_t *config1 );
481 
493 void pwm_channel_state ( pwm_t *ctx, uint8_t chann_id, uint8_t state );
494 
505 void pwm_set_channel_raw ( pwm_t *ctx, uint8_t chann_id, uint16_t raw_off_set, uint16_t raw_dc );
506 
517 void pwm_all_chann_state( pwm_t *ctx, uint8_t state );
518 
527 void pwm_set_pre_scale ( pwm_t *ctx, uint8_t pre_scale );
528 
537 void pwm_set_all_raw ( pwm_t *ctx, uint16_t raw_dc );
538 
547 void pwm_set_all ( pwm_t *ctx, uint8_t duty_cyc );
548 
549 #ifdef __cplusplus
550 }
551 #endif
552 #endif // _PWM_H_
553  // End public_function group
556 
557 // ------------------------------------------------------------------------- END
pwm_set_all_raw
void pwm_set_all_raw(pwm_t *ctx, uint16_t raw_dc)
Set all channels raw function.
pwm_cfg_setup
void pwm_cfg_setup(pwm_cfg_t *cfg)
Config Object Initialization function.
pwm_set_channel_raw
void pwm_set_channel_raw(pwm_t *ctx, uint8_t chann_id, uint16_t raw_off_set, uint16_t raw_dc)
Set channel raw function.
pwm_cfg_t
Click configuration structure definition.
Definition: pwm.h:348
pwm_t::i2c
i2c_master_t i2c
Definition: pwm.h:337
pwm_set_pre_scale
void pwm_set_pre_scale(pwm_t *ctx, uint8_t pre_scale)
Set pre scale function.
pwm_cfg_t::sda
pin_name_t sda
Definition: pwm.h:353
pwm_generic_read
void pwm_generic_read(pwm_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic read function.
pwm_init
PWM_RETVAL pwm_init(pwm_t *ctx, pwm_cfg_t *cfg)
Initialization function.
PWM_RETVAL
#define PWM_RETVAL
Definition: pwm.h:68
pwm_set_all
void pwm_set_all(pwm_t *ctx, uint8_t duty_cyc)
Set all channels function.
pwm_channel_state
void pwm_channel_state(pwm_t *ctx, uint8_t chann_id, uint8_t state)
Channel state function.
pwm_t::slave_address
uint8_t slave_address
Definition: pwm.h:341
pwm_dev_config
void pwm_dev_config(pwm_t *ctx, uint8_t *config)
Device configuration function.
pwm_cfg_t::scl
pin_name_t scl
Definition: pwm.h:352
pwm_cfg_t::rst
pin_name_t rst
Definition: pwm.h:357
pwm_all_chann_state
void pwm_all_chann_state(pwm_t *ctx, uint8_t state)
All channels state function.
pwm_generic_write
void pwm_generic_write(pwm_t *ctx, uint8_t reg, uint8_t *data_buf, uint8_t len)
Generic write function.
pwm_cfg_t::i2c_address
uint8_t i2c_address
Definition: pwm.h:362
pwm_cfg_t::i2c_speed
uint32_t i2c_speed
Definition: pwm.h:361
pwm_t::rst
digital_out_t rst
Definition: pwm.h:333
pwm_output_config
void pwm_output_config(pwm_t *ctx, uint8_t *config1)
Output configuration function.
pwm_set_output
void pwm_set_output(pwm_t *ctx, uint8_t en_ou)
Output state set function.
pwm_t
Click ctx object definition.
Definition: pwm.h:329