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