261 lines
8.9 KiB
C
261 lines
8.9 KiB
C
/****************************************************************************
|
|
* include/nuttx/leds/userled.h
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF licenses this file to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance with the
|
|
* License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
* License for the specific language governing permissions and limitations
|
|
* under the License.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifndef __INCLUDE_NUTTX_LEDS_USERLED_H
|
|
#define __INCLUDE_NUTTX_LEDS_USERLED_H
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
#include <nuttx/fs/ioctl.h>
|
|
|
|
#include <stdbool.h>
|
|
|
|
/****************************************************************************
|
|
* Pre-processor Definitions
|
|
****************************************************************************/
|
|
|
|
/* ioctl commands */
|
|
|
|
/* Command: ULEDIOC_SUPPORTED
|
|
* Description: Report the set of LEDs supported by the hardware;
|
|
* Argument: A pointer to writeable userled_set_t value in which to
|
|
* return the set of supported LEDs.
|
|
* Return: Zero (OK) on success. Minus one will be returned on failure
|
|
* with the errno value set appropriately.
|
|
*/
|
|
|
|
#define ULEDIOC_SUPPORTED _ULEDIOC(0x0001)
|
|
|
|
/* Command: ULEDIOC_SETLED
|
|
* Description: Set the state of one LED.
|
|
* Argument: A read-only pointer to an instance of struct userled_s
|
|
* Return: Zero (OK) on success. Minus one will be returned on failure
|
|
* with the errno value set appropriately.
|
|
*/
|
|
|
|
#define ULEDIOC_SETLED _ULEDIOC(0x0002)
|
|
|
|
/* Command: ULEDIOC_SETALL
|
|
* Description: Set the state of all LEDs.
|
|
* Argument: A value of type userled_set_t cast to unsigned long
|
|
* Return: Zero (OK) on success. Minus one will be returned on failure
|
|
* with the errno value set appropriately.
|
|
*/
|
|
|
|
#define ULEDIOC_SETALL _ULEDIOC(0x0003)
|
|
|
|
/* Command: ULEDIOC_GETALL
|
|
* Description: Get the state of all LEDs.
|
|
* Argument: A write-able pointer to a userled_set_t memory location in
|
|
* which to return the LED state.
|
|
* Return: Zero (OK) on success. Minus one will be returned on failure
|
|
* with the errno value set appropriately.
|
|
*/
|
|
|
|
#define ULEDIOC_GETALL _ULEDIOC(0x0004)
|
|
|
|
/* Command: ULEDIOC_SUPEFFECT
|
|
* Description: Get supported effects of one LED.
|
|
* Argument: A write-able pointer to a struct userled_effect_sup_s
|
|
* which to return the supported LED effects.
|
|
* Return: Zero (OK) on success. Minus one will be returned on failure
|
|
* with the errno value set appropriately.
|
|
*/
|
|
|
|
#define ULEDIOC_SUPEFFECT _ULEDIOC(0x0005)
|
|
|
|
/* Command: ULEDIOC_SETEFFECT
|
|
* Description: Set effects for one LED.
|
|
* Argument: A read-only pointer to an instance of
|
|
* struct userled_effect_set_s.
|
|
* Return: Zero (OK) on success. Minus one will be returned on failure
|
|
* with the errno value set appropriately.
|
|
*/
|
|
|
|
#define ULEDIOC_SETEFFECT _ULEDIOC(0x0006)
|
|
|
|
/****************************************************************************
|
|
* Public Types
|
|
****************************************************************************/
|
|
|
|
/* This type is a bit set that contains the state of all LEDs as defined
|
|
* in arch/board/board.h. This is the value that is returned when reading
|
|
* from or writing to the LED driver.
|
|
*/
|
|
|
|
typedef uint32_t userled_set_t;
|
|
|
|
/* A reference to this structure is provided with the ULEDIOC_SETLED IOCTL
|
|
* command and describes the LED to be set and the new value of the LED.
|
|
* The encoding of LEDs is provided in the board-specific board.h header
|
|
* file.
|
|
*/
|
|
|
|
struct userled_s
|
|
{
|
|
uint8_t ul_led; /* Identifies the LED */
|
|
bool ul_on; /* The LED state. true: ON; false: OFF */
|
|
};
|
|
|
|
#ifdef CONFIG_USERLED_EFFECTS
|
|
|
|
/* This structure describes LED effects supported by a given LED. */
|
|
|
|
struct userled_effect_sup_s
|
|
{
|
|
uint8_t led; /* LED number */
|
|
|
|
uint8_t int_on:1; /* ON intensity supported */
|
|
uint8_t int_off:1; /* OFF intensity supported */
|
|
uint8_t t_on:1; /* ON time supported */
|
|
uint8_t t_off:1; /* OFF time supported */
|
|
uint8_t t_fade:1; /* Fade in supported */
|
|
uint8_t t_fall:1; /* Fade out supported */
|
|
uint8_t _res:2; /* Reserved */
|
|
};
|
|
|
|
/* This structure describes the LED effect to be set on a given LED. */
|
|
|
|
struct userled_effect_set_s
|
|
{
|
|
uint8_t led; /* LED number */
|
|
|
|
uint8_t int_on; /* ON intesinty [0% - 100%] */
|
|
uint8_t int_off; /* OFF intensity [0% - 100%] */
|
|
uint32_t t_on; /* ON time [ms] */
|
|
uint32_t t_off; /* OFF intensity [ms] */
|
|
uint8_t t_fade; /* Fade in setting */
|
|
uint8_t t_fall; /* Fade out setting */
|
|
};
|
|
#endif
|
|
|
|
/* The user LED driver is a two-part driver:
|
|
*
|
|
* 1) A common upper half driver that provides the common user interface to
|
|
* the LEDs,
|
|
* 2) Platform-specific lower half drivers that provide the interface
|
|
* between the common upper half and the platform discrete LED outputs.
|
|
*
|
|
* This structure defines the interface between an instance of the lower
|
|
* half driver and the common upper half driver. Such an instance is
|
|
* passed to the upper half driver when the driver is initialized, binding
|
|
* the upper and lower halves into one driver.
|
|
*/
|
|
|
|
struct userled_lowerhalf_s
|
|
{
|
|
/* Return the set of LEDs supported by the board */
|
|
|
|
CODE userled_set_t
|
|
(*ll_supported)(FAR const struct userled_lowerhalf_s *lower);
|
|
|
|
/* Set the current state of one LED */
|
|
|
|
CODE void (*ll_setled)(FAR const struct userled_lowerhalf_s *lower,
|
|
int led, bool ledon);
|
|
|
|
/* Set the state of all LEDs */
|
|
|
|
CODE void (*ll_setall)(FAR const struct userled_lowerhalf_s *lower,
|
|
userled_set_t ledset);
|
|
|
|
#ifdef CONFIG_USERLED_LOWER_READSTATE
|
|
/* Get the state of all LEDs */
|
|
|
|
CODE void (*ll_getall)(FAR const struct userled_lowerhalf_s *lower,
|
|
userled_set_t *ledset);
|
|
#endif
|
|
|
|
#ifdef CONFIG_USERLED_EFFECTS
|
|
/* Return the LED effects supported by a given LED */
|
|
|
|
CODE void (*ll_effect_sup)(FAR const struct userled_lowerhalf_s *lower,
|
|
FAR struct userled_effect_sup_s *supp);
|
|
|
|
/* Set the effect of one LED */
|
|
|
|
CODE int (*ll_effect_set)(FAR const struct userled_lowerhalf_s *lower,
|
|
FAR struct userled_effect_set_s *effect);
|
|
|
|
#endif
|
|
};
|
|
|
|
/****************************************************************************
|
|
* Public Data
|
|
****************************************************************************/
|
|
|
|
#ifdef __cplusplus
|
|
#define EXTERN extern "C"
|
|
extern "C"
|
|
{
|
|
#else
|
|
#define EXTERN extern
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Function Prototypes
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: userled_register
|
|
*
|
|
* Description:
|
|
* Bind the lower half LED driver to an instance of the upper half
|
|
* LED driver and register the composite character driver as the
|
|
* specified device.
|
|
*
|
|
* Input Parameters:
|
|
* devname - The name of the LED device to be registered.
|
|
* This should be a string of the form "/dev/ledN" where N is the
|
|
* minor device number.
|
|
* lower - An instance of the platform-specific LED lower half driver.
|
|
*
|
|
* Returned Value:
|
|
* Zero (OK) is returned on success. Otherwise a negated errno value is
|
|
* returned to indicate the nature of the failure.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int userled_register(FAR const char *devname,
|
|
FAR const struct userled_lowerhalf_s *lower);
|
|
|
|
/****************************************************************************
|
|
* Name: userled_lower_initialize
|
|
*
|
|
* Description:
|
|
* Initialize the generic LED lower half driver, bind it and register
|
|
* it with the upper half LED driver as devname.
|
|
*
|
|
****************************************************************************/
|
|
|
|
#ifdef CONFIG_USERLED_LOWER
|
|
int userled_lower_initialize(FAR const char *devname);
|
|
#endif
|
|
|
|
#undef EXTERN
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __INCLUDE_NUTTX_LEDS_USERLED_H */
|