mcp1664  2.0.0.0
mcp1664.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 MCP1664_H
36 #define MCP1664_H
37 
42 #ifdef PREINIT_SUPPORTED
43 #include "preinit.h"
44 #endif
45 
46 #ifdef MikroCCoreVersion
47  #if MikroCCoreVersion >= 1
48  #include "delays.h"
49  #endif
50 #endif
51 
52 #include "drv_digital_out.h"
53 #include "drv_digital_in.h"
54 #include "drv_pwm.h"
55 
56 // -------------------------------------------------------------- PUBLIC MACROS
66 #define MCP1664_MAP_MIKROBUS( cfg, mikrobus ) \
67  cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
68 
74 #define MCP1664_RETVAL uint8_t
75 
76 #define MCP1664_OK 0x00
77 #define MCP1664_INIT_ERROR 0xFF
78 
84 #define MCP1664_DEF_FREQ 20000
85  // End group macro
88 // --------------------------------------------------------------- PUBLIC TYPES
97 typedef struct
98 {
99  // Modules
100 
101  pwm_t pwm;
102 
103  // ctx variable
104 
105  uint32_t pwm_freq;
106 
107 } mcp1664_t;
108 
112 typedef struct
113 {
114  // Communication gpio pins
115 
116  pin_name_t pwm;
117 
118  // static variable
119 
120  uint32_t dev_pwm_freq;
121 
122 } mcp1664_cfg_t;
123  // End types group
125 // ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
126 
132 #ifdef __cplusplus
133 extern "C"{
134 #endif
135 
145 
155 
164 void mcp1664_set_duty_cycle ( mcp1664_t *ctx, float duty_cycle );
165 
174 
183 
184 #ifdef __cplusplus
185 }
186 #endif
187 #endif // _MCP1664_H_
188  // End public_function group
191 
192 // ------------------------------------------------------------------------- END
mcp1664_pwm_stop
void mcp1664_pwm_stop(mcp1664_t *ctx)
Stop PWM module.
mcp1664_pwm_start
void mcp1664_pwm_start(mcp1664_t *ctx)
Start PWM module.
mcp1664_t::pwm_freq
uint32_t pwm_freq
Definition: mcp1664.h:105
MCP1664_RETVAL
#define MCP1664_RETVAL
Definition: mcp1664.h:74
mcp1664_t
Click ctx object definition.
Definition: mcp1664.h:98
mcp1664_set_duty_cycle
void mcp1664_set_duty_cycle(mcp1664_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
mcp1664_cfg_t::dev_pwm_freq
uint32_t dev_pwm_freq
Definition: mcp1664.h:120
mcp1664_t::pwm
pwm_t pwm
Definition: mcp1664.h:101
mcp1664_cfg_setup
void mcp1664_cfg_setup(mcp1664_cfg_t *cfg)
Config Object Initialization function.
mcp1664_cfg_t::pwm
pin_name_t pwm
Definition: mcp1664.h:116
mcp1664_init
MCP1664_RETVAL mcp1664_init(mcp1664_t *ctx, mcp1664_cfg_t *cfg)
Initialization function.
mcp1664_cfg_t
Click configuration structure definition.
Definition: mcp1664.h:113