xref: /freebsd/sys/dev/pwm/pwmbus_if.m (revision 069ac184)
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
29#include <sys/bus.h>
30
31INTERFACE pwmbus;
32
33CODE {
34	static int
35	pwm_default_set_flags(device_t bus, u_int channel, uint32_t flags)
36	{
37
38		return (EOPNOTSUPP);
39	}
40
41	static int
42	pwm_default_get_flags(device_t bus, u_int channel, uint32_t *flags)
43	{
44
45		*flags = 0;
46		return (0);
47	}
48};
49
50#
51# Config the period (Total number of cycle in ns) and
52# the duty (active number of cycle in ns)
53#
54METHOD int channel_config {
55	device_t bus;
56	u_int channel;
57	u_int period;
58	u_int duty;
59};
60
61#
62# Get the period (Total number of cycle in ns) and
63# the duty (active number of cycle in ns)
64#
65METHOD int channel_get_config {
66	device_t bus;
67	u_int channel;
68	u_int *period;
69	u_int *duty;
70};
71
72#
73# Set the flags
74#
75METHOD int channel_set_flags {
76	device_t bus;
77	u_int channel;
78	uint32_t flags;
79} DEFAULT pwm_default_set_flags;
80
81#
82# Get the flags
83#
84METHOD int channel_get_flags {
85	device_t bus;
86	u_int channel;
87	uint32_t *flags;
88} DEFAULT pwm_default_get_flags;
89
90#
91# Enable the pwm output
92#
93METHOD int channel_enable {
94	device_t bus;
95	u_int channel;
96	bool enable;
97};
98
99#
100# Is the pwm output enabled
101#
102METHOD int channel_is_enabled {
103	device_t bus;
104	u_int channel;
105	bool *enabled;
106};
107
108#
109# Get the number of channels
110#
111METHOD int channel_count {
112	device_t bus;
113	u_int *nchannel;
114};
115