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
38#include "drv_digital_out.h"
39#include "drv_digital_in.h"
40#include "drv_pwm.h"
41
42// -------------------------------------------------------------- PUBLIC MACROS
52#define MCP1664_MAP_MIKROBUS( cfg, mikrobus ) \
53 cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM )
60#define MCP1664_RETVAL uint8_t
61
62#define MCP1664_OK 0x00
63#define MCP1664_INIT_ERROR 0xFF
70#define MCP1664_DEF_FREQ 20000 // End group macro
74// --------------------------------------------------------------- PUBLIC TYPES
83typedef struct
84{
85 // Modules
86
87 pwm_t pwm;
88
89 // ctx variable
90
91 uint32_t pwm_freq;
92
93} mcp1664_t;
94
98typedef struct
99{
100 // Communication gpio pins
101
102 pin_name_t pwm;
103
104 // static variable
105
106 uint32_t dev_pwm_freq;
107
109 // End types group
111// ----------------------------------------------- PUBLIC FUNCTION DECLARATIONS
112
118#ifdef __cplusplus
119extern "C"{
120#endif
121
131
141
150void mcp1664_set_duty_cycle ( mcp1664_t *ctx, float duty_cycle );
151
160
169
170#ifdef __cplusplus
171}
172#endif
173#endif // _MCP1664_H_
174 // End public_function group
177
178// ------------------------------------------------------------------------- END
#define MCP1664_RETVAL
Definition: mcp1664.h:60
void mcp1664_pwm_start(mcp1664_t *ctx)
Start PWM module.
void mcp1664_cfg_setup(mcp1664_cfg_t *cfg)
Config Object Initialization function.
void mcp1664_pwm_stop(mcp1664_t *ctx)
Stop PWM module.
void mcp1664_set_duty_cycle(mcp1664_t *ctx, float duty_cycle)
Generic sets PWM duty cycle.
MCP1664_RETVAL mcp1664_init(mcp1664_t *ctx, mcp1664_cfg_t *cfg)
Initialization function.
Click configuration structure definition.
Definition: mcp1664.h:99
uint32_t dev_pwm_freq
Definition: mcp1664.h:106
pin_name_t pwm
Definition: mcp1664.h:102
Click ctx object definition.
Definition: mcp1664.h:84
uint32_t pwm_freq
Definition: mcp1664.h:91
pwm_t pwm
Definition: mcp1664.h:87