xref: /freebsd/sys/dev/pwm/pwmbus.h (revision 6829dae12bb055451fa467da4589c43bd03b1e64)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org>
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 AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, 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  * $FreeBSD$
29  */
30 
31 #ifndef _PWMBUS_H_
32 
33 #include <dev/ofw/openfirm.h>
34 #include <sys/pwm.h>
35 
36 struct pwm_channel {
37 	device_t	dev;
38 	device_t	busdev;
39 	int		channel;
40 	uint64_t	period;
41 	uint64_t	duty;
42 	uint32_t	flags;
43 	bool		enabled;
44 };
45 typedef struct pwm_channel *pwm_channel_t;
46 
47 device_t pwmbus_attach_bus(device_t dev);
48 int pwmbus_acquire_channel(device_t bus, int channel);
49 int pwmbus_release_channel(device_t bus, int channel);
50 
51 int
52 pwm_get_by_ofw_propidx(device_t consumer, phandle_t node,
53     const char *prop_name, int idx, pwm_channel_t *channel);
54 int
55 pwm_get_by_ofw_idx(device_t consumer, phandle_t node, int idx,
56     pwm_channel_t *out_channel);
57 int
58 pwm_get_by_ofw_property(device_t consumer, phandle_t node,
59     const char *prop_name, pwm_channel_t *out_channel);
60 int
61 pwm_get_by_ofw_name(device_t consumer, phandle_t node, const char *name,
62     pwm_channel_t *out_channel);
63 
64 #endif /* _PWMBUS_H_ */
65