summaryrefslogtreecommitdiff
path: root/digital/io-hub/src/common/pwm.h
blob: aff84b39bdbe49aebd5a1f94905afadb38c18d28 (plain)
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
#ifndef pwm_h
#define pwm_h
/* pwm.h */
/* io-hub - Modular Input/Output. {{{
 *
 * Copyright (C) 2011 Nicolas Schodet
 *
 * APBTeam:
 *        Web: http://apbteam.org/
 *      Email: team AT apbteam DOT org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 * }}} */

/** Handle PWM output with direction.  Also handle timed PWM setting to apply
 * a PWM value for a given number of update, then switch to a resting value.
 *
 * AC_IOHUB_PWM should be set to a list of space separated PWM macro call:
 *
 * PWM (timer, pwm, pwm_io_port, pwm_io_n, dir_io_port, dir_io_n)
 *
 * For example:
 *
 * PWM (1, A, B, 1, B, 2) => use output compare A on timer 1, PWM output on
 * B1, direction on B2. */

/** Maximum positive value. */
#define PWM_MAX 0x3ff

/** Initialise PWM module. */
void
pwm_init (void);

/** Update PWM module (handle timed PWM). */
void
pwm_update (void);

/** Set PWM value for given PWM index. */
void
pwm_set (uint8_t index, int16_t value);

/** Set PWM value for given PWM index for a given time.  After time elapsed,
 * use a rest value. */
void
pwm_set_timed (uint8_t index, int16_t value, uint16_t time, int16_t value_rest);

#endif /* pwm_h */