/
pwm.h
177 lines (159 loc) · 4.44 KB
/
pwm.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/**
* @section License
*
* The MIT License (MIT)
*
* Copyright (c) 2014-2017, Erik Moqvist
*
* Permission is hereby granted, free of charge, to any person
* obtaining a copy of this software and associated documentation
* files (the "Software"), to deal in the Software without
* restriction, including without limitation the rights to use, copy,
* modify, merge, publish, distribute, sublicense, and/or sell copies
* of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* This file is part of the Simba project.
*/
#ifndef __DRIVERS_PWM_H__
#define __DRIVERS_PWM_H__
#include "simba.h"
#include "pwm_port.h"
extern struct pwm_device_t pwm_device[PWM_DEVICE_MAX];
/**
* Initialize the pwm module. This function must be called before
* calling any other function in this module.
*
* The module will only be initialized once even if this function is
* called multiple times.
*
* @return zero(0) or negative error code.
*/
int pwm_module_init(void);
/**
* Initialize given PWM driver object.
*
* @param[out] self_p Driver object to be initialized.
* @param[in] dev_p PWM device to use.
* @param[in] frequency Frequency.
* @param[in] duty_cycle Duty cycle.
*
* @return zero(0) or negative error code.
*/
int pwm_init(struct pwm_driver_t *self_p,
struct pwm_device_t *dev_p,
long frequency,
long duty_cycle);
/**
* Start given PWM driver object.
*
* @param[in] self_p Driver object to start.
*
* @return zero(0) or negative error code.
*/
int pwm_start(struct pwm_driver_t *self_p);
/**
* Stop given PWM driver object.
*
* @param[in] self_p Driver object to stop.
*
* @return zero(0) or negative error code.
*/
int pwm_stop(struct pwm_driver_t *self_p);
/**
* Set the frequency of the PWM signal.
*
* @param[in] self_p Driver object.
* @param[in] value Frequency. Use `pwm_frequency()` to convert a
* frequency in Hertz to a value expected by this
* function.
*
* @return zero(0) or negative error code.
*/
int pwm_set_frequency(struct pwm_driver_t *self_p,
long value);
/**
* Get current frequency.
*
* @param[in] self_p Driver object.
*
* @return Current frequency.
*/
long pwm_get_frequency(struct pwm_driver_t *self_p);
/**
* Set the duty cycle of the signal.
*
* @param[in] self_p Driver object.
* @param[in] value Duty cycle. Use `pwm_duty_cycle()` to convert a
* duty cycle percentage to a value expected by this
* function.
*
* @return zero(0) or negative error code.
*/
int pwm_set_duty_cycle(struct pwm_driver_t *self_p,
long value);
/**
* Get current duty cycle.
*
* @param[in] self_p Driver object.
*
* @return Current duty cycle.
*/
long pwm_get_duty_cycle(struct pwm_driver_t *self_p);
/**
* Convert a duty cycle percentage to a value for
* `pwm_set_frequency()`.
*
* @param[in] hertz Frequency in Hertz.
*
* @return Frequency.
*/
long pwm_frequency(int hertz);
/**
* Convert a frequency value returned by `pwm_get_frequency()` to
* Hertz.
*
* @param[in] value Frequency.
*
* @return Frequency in Hertz.
*/
int pwm_frequency_as_hertz(long value);
/**
* Convert a duty cycle percentage to a value for
* `pwm_set_duty_cycle()`.
*
* @param[in] percentage Duty cycle percentage.
*
* @return Duty cycle.
*/
long pwm_duty_cycle(int percentage);
/**
* Convert a duty cycle value returned by `pwm_get_duty_cycle()` to a
* percentage.
*
* @param[in] value Duty cycle.
*
* @return Duty cycle percentage.
*/
int pwm_duty_cycle_as_percent(long value);
/**
* Get the PWM device for given pin.
*
* @param[in] pin_p The pin device to get the PWM device for.
*
* @return PWM device, or NULL on error.
*/
struct pwm_device_t *pwm_pin_to_device(struct pin_device_t *pin_p);
#endif