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