1/* $NetBSD: pwmvar.h,v 1.1 2018/05/06 10:32:33 jmcneill Exp $ */
2
3/*-
4 * Copyright (c) 2018 Jared McNeill <jmcneill@invisible.ca>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 *    notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 *    notice, this list of conditions and the following disclaimer in the
14 *    documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
21 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
23 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
24 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * SUCH DAMAGE.
27 */
28
29#ifndef _DEV_PWM_PWMVAR_H
30#define _DEV_PWM_PWMVAR_H
31
32enum pwm_polarity {
33	PWM_ACTIVE_HIGH,
34	PWM_ACTIVE_LOW
35};
36
37struct pwm_config {
38	u_int	period;			/* nanoseconds */
39	u_int	duty_cycle;		/* nanoseconds */
40	enum pwm_polarity polarity;	/* PWM_ACTIVE_{HIGH,LOW} */
41};
42
43typedef struct pwm_controller {
44	int	(*pwm_enable)(struct pwm_controller *, bool);
45	int	(*pwm_get_config)(struct pwm_controller *,
46				  struct pwm_config *);
47	int	(*pwm_set_config)(struct pwm_controller *,
48				  const struct pwm_config *);
49
50	device_t pwm_dev;		/* device */
51	void	*pwm_priv;		/* driver private data */
52} *pwm_tag_t;
53
54int	pwm_enable(pwm_tag_t);
55int	pwm_disable(pwm_tag_t);
56int	pwm_get_config(pwm_tag_t, struct pwm_config *);
57int	pwm_set_config(pwm_tag_t, const struct pwm_config *);
58
59#endif /* _DEV_PWM_PWMVAR_H */
60