Changeset View
Changeset View
Standalone View
Standalone View
sys/dev/pwm/pwm_if.m
- This file was added.
#- | |||||
# SPDX-License-Identifier: BSD-2-Clause-FreeBSD | |||||
# | |||||
# Copyright (c) 2018 Emmanuel Vadot <manu@FreeBSD.org> | |||||
# | |||||
# Redistribution and use in source and binary forms, with or without | |||||
# modification, are permitted provided that the following conditions | |||||
# are met: | |||||
# 1. Redistributions of source code must retain the above copyright | |||||
# notice, this list of conditions and the following disclaimer. | |||||
# 2. Redistributions in binary form must reproduce the above copyright | |||||
# notice, this list of conditions and the following disclaimer in the | |||||
# documentation and/or other materials provided with the distribution. | |||||
# | |||||
# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||
# ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||
# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||
# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||
# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||
# SUCH DAMAGE. | |||||
# | |||||
# $FreeBSD$ | |||||
# | |||||
#include <sys/bus.h> | |||||
INTERFACE pwm; | |||||
# | |||||
# Get the bus | |||||
# | |||||
METHOD device_t get_bus { | |||||
device_t dev; | |||||
}; | |||||
# | |||||
# Config the period (Total number of cycle in ns) and | |||||
# the duty (active number of cycle in ns) | |||||
# | |||||
METHOD int channel_config { | |||||
device_t dev; | |||||
int channel; | |||||
uint64_t period; | |||||
uint64_t duty; | |||||
}; | |||||
# | |||||
# Get the period (Total number of cycle in ns) and | |||||
# the duty (active number of cycle in ns) | |||||
# | |||||
METHOD int channel_get_config { | |||||
device_t dev; | |||||
int channel; | |||||
uint64_t *period; | |||||
uint64_t *duty; | |||||
}; | |||||
# | |||||
# Set the flags | |||||
# | |||||
METHOD int channel_set_flags { | |||||
device_t dev; | |||||
int channel; | |||||
uint32_t flags; | |||||
}; | |||||
# | |||||
# Get the flags | |||||
# | |||||
METHOD int channel_get_flags { | |||||
device_t dev; | |||||
int channel; | |||||
uint32_t *flags; | |||||
}; | |||||
# | |||||
# Enable the pwm output | |||||
# | |||||
METHOD int channel_enable { | |||||
device_t dev; | |||||
int channel; | |||||
bool enable; | |||||
}; | |||||
# | |||||
# Is the pwm output enabled | |||||
# | |||||
METHOD int channel_is_enabled { | |||||
device_t dev; | |||||
int channel; | |||||
bool *enabled; | |||||
}; | |||||
# | |||||
# Get the number of channels | |||||
# | |||||
METHOD int channel_max { | |||||
device_t dev; | |||||
int *nchannel; | |||||
}; | |||||
mizhka: Is it worth to remove "channel_" prefix? | |||||
Done Inline ActionsI honestly don't mind, I added the channel prefix as you operate on a channel and not on the whole device. manu: I honestly don't mind, I added the channel prefix as you operate on a channel and not on the… | |||||
Not Done Inline ActionsMay be worth to rename to get_size / get_quantity? mizhka: May be worth to rename to get_size / get_quantity? | |||||
Done Inline ActionsThis was done to mimic gpio, and I think it's clear enough was you get calling thing method manu: This was done to mimic gpio, and I think it's clear enough was you get calling thing method |
Is it worth to remove "channel_" prefix?