xref: /freebsd/sys/dev/pwm/ofw_pwm.h (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _OFW_PWM_H_
29 #define _OFW_PWM_H_
30 
31 #include <dev/ofw/openfirm.h>
32 
33 struct pwm_channel {
34 	device_t	dev;
35 	u_int		channel;
36 	uint64_t	period;
37 	uint64_t	duty;
38 	uint32_t	flags;
39 	bool		enabled;
40 };
41 typedef struct pwm_channel *pwm_channel_t;
42 
43 int pwm_get_by_ofw_propidx(device_t consumer, phandle_t node,
44     const char *prop_name, int idx, pwm_channel_t *channel);
45 int pwm_get_by_ofw_idx(device_t consumer, phandle_t node, int idx,
46     pwm_channel_t *out_channel);
47 int pwm_get_by_ofw_property(device_t consumer, phandle_t node,
48     const char *prop_name, pwm_channel_t *out_channel);
49 int pwm_get_by_ofw_name(device_t consumer, phandle_t node, const char *name,
50     pwm_channel_t *out_channel);
51 
52 #endif /* _OFW_PWM_H_ */
53