mirror of
https://github.com/apache/nuttx.git
synced 2026-05-20 12:33:27 +08:00
Add a generic user LED upper half discrete driver
This commit is contained in:
Gregory Nutt
@@ -548,6 +548,16 @@ config DEBUG_INPUT
|
||||
this debug option is board-specific and may not be available for
|
||||
some boards.
|
||||
|
||||
config DEBUG_DISCRETE
|
||||
bool "Discrete I/O Debug Output"
|
||||
default n
|
||||
depends on DISCRETE_IO
|
||||
---help---
|
||||
Enable low level debug SYSLOG output from the discrete I/O device
|
||||
drivers such as LEDs and I/O expanders (disabled by default).
|
||||
Support for this debug option is board-specific and may not be
|
||||
available for some boards.
|
||||
|
||||
config DEBUG_ANALOG
|
||||
bool "Analog Device Debug Output"
|
||||
default n
|
||||
|
||||
@@ -42,3 +42,39 @@ config PCA9555_INT_DISABLE
|
||||
|
||||
endif # IOEXPANDER_PCA9555
|
||||
endif # IOEXPANDER
|
||||
|
||||
config USERLED
|
||||
bool "LED driver"
|
||||
default n
|
||||
depends on ARCH_HAVE_LEDS
|
||||
---help---
|
||||
Enable standard user LED upper half driver.
|
||||
|
||||
if USERLED
|
||||
|
||||
config USERLED_LOWER
|
||||
bool "Generic Lower Half LED Driver"
|
||||
default n
|
||||
---help---
|
||||
If the board supports the standard LED interfaces as
|
||||
defined in include/nuttx/board.h header file, then this
|
||||
standard LED lower half driver might be usable.
|
||||
|
||||
In order for this generic driver to be usable:
|
||||
|
||||
1. The board implementation must provide the LED
|
||||
interfaces as defined in include/nuttx/board.h
|
||||
2. The board.h header file must provide the definition
|
||||
NUM_USERLED, and
|
||||
3. The board.h header file must not include any other
|
||||
header files that are not accessibble in this context
|
||||
(such as those in arch/<arch>/src/<chip>) UNLESS those
|
||||
inclusions are conditioned on __KERNEL__. button_lower.c
|
||||
will undefine __KERNEL__ before included board.h.
|
||||
|
||||
If your board does not meet these requirements, then the
|
||||
userled_lower.c file can still be copied to your your
|
||||
board src/ directory and modified for your specific board
|
||||
requirements.
|
||||
|
||||
endif # USERLED
|
||||
|
||||
@@ -33,17 +33,31 @@
|
||||
#
|
||||
############################################################################
|
||||
|
||||
# Don't build anything if there is no support for io expander devices
|
||||
# Don't build anything if there is no support for discrete devices
|
||||
|
||||
ifeq ($(CONFIG_DISCRETE_IO),y)
|
||||
|
||||
# Include user LED driver
|
||||
|
||||
ifeq ($(CONFIG_USERLED),y)
|
||||
CSRCS += userled_upper.c
|
||||
ifeq ($(CONFIG_USERLED_LOWER),y)
|
||||
CSRCS += userled_lower.c
|
||||
endif
|
||||
endif
|
||||
|
||||
# Check if I/O expander support is enabled
|
||||
|
||||
ifeq ($(CONFIG_IOEXPANDER),y)
|
||||
|
||||
# Include the selected io expander drivers
|
||||
# Include the selected I/O expander drivers
|
||||
|
||||
ifeq ($(CONFIG_IOEXPANDER_PCA9555),y)
|
||||
CSRCS += pca9555.c
|
||||
endif
|
||||
endif
|
||||
|
||||
# Include io expander device driver build support
|
||||
# Include discrete I/O device driver build support
|
||||
|
||||
DEPPATH += --dep-path discrete
|
||||
VPATH += :discrete
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -354,7 +354,7 @@ config BUTTONS_LOWER
|
||||
will undefine __KERNEL__ before included board.h.
|
||||
|
||||
If your board does not meet these requirements, then the
|
||||
board_lower.c file can still be copied to your your
|
||||
button_lower.c file can still be copied to your your
|
||||
board src/ directory and modified for your specific board
|
||||
requirements.
|
||||
|
||||
|
||||
@@ -101,6 +101,7 @@
|
||||
#include <nuttx/config.h>
|
||||
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
#include <nuttx/compiler.h>
|
||||
|
||||
|
||||
@@ -0,0 +1,185 @@
|
||||
/************************************************************************************
|
||||
* include/nuttx/input/userled.h
|
||||
*
|
||||
* Copyright (C) 2015 Gregory Nutt. All rights reserved.
|
||||
* Author: Gregory Nutt <gnutt@nuttx.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.
|
||||
* 3. Neither the name NuttX nor the names of its contributors may be
|
||||
* used to endorse or promote products derived from this software
|
||||
* without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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
|
||||
* COPYRIGHT OWNER 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.
|
||||
*
|
||||
************************************************************************************/
|
||||
|
||||
#ifndef __INCLUDE_NUTTX_DISCRETE_USERLED_H
|
||||
#define __INCLUDE_NUTTX_DISCRETE_USERLED_H
|
||||
|
||||
/****************************************************************************
|
||||
* Included Files
|
||||
****************************************************************************/
|
||||
|
||||
#include <nuttx/config.h>
|
||||
#include <nuttx/fs/ioctl.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 one LED.
|
||||
* 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)
|
||||
|
||||
/****************************************************************************
|
||||
* 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 uint8_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 */
|
||||
};
|
||||
|
||||
/* 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_led)(FAR const struct userled_lowerhalf_s *lower,
|
||||
int led, bool ledon);
|
||||
|
||||
/* Set the state of all LEDs */
|
||||
|
||||
CODE void (*ll_ledset)(FAR const struct userled_lowerhalf_s *lower,
|
||||
userled_set_t ledset);
|
||||
};
|
||||
|
||||
/****************************************************************************
|
||||
* 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 the
|
||||
* minor device number.
|
||||
* lower - An instance of the platform-specific LED lower half driver.
|
||||
*
|
||||
* Returned Values:
|
||||
* 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);
|
||||
|
||||
#undef EXTERN
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* __INCLUDE_NUTTX_DISCRETE_USERLED_H */
|
||||
@@ -78,8 +78,12 @@
|
||||
#define _RELAYBASE (0x1900) /* Relay devices ioctl commands */
|
||||
#define _CANBASE (0x1a00) /* CAN ioctl commands */
|
||||
#define _BTNBASE (0x1b00) /* Button ioctl commands */
|
||||
#define _ZCBASE (0x1c00) /* Zero Cross ioctl commands */
|
||||
#define _BOARDBASE (0x1d00) /* boardctl ioctl commands */
|
||||
#define _ULEDBASE (0x1c00) /* User LED ioctl commands */
|
||||
#define _ZCBASE (0x1d00) /* Zero Cross ioctl commands */
|
||||
|
||||
/* boardctl commands share the same number space */
|
||||
|
||||
#define _BOARDBASE (0xff00) /* boardctl commands */
|
||||
|
||||
/* Macros used to manage ioctl commands */
|
||||
|
||||
@@ -339,11 +343,17 @@
|
||||
#define _CANIOC(nr) _IOC(_CANBASE,nr)
|
||||
|
||||
/* Button driver ioctl definitions ******************************************/
|
||||
/* (see nuttx/can.h */
|
||||
/* (see nuttx/input/buttons.h */
|
||||
|
||||
#define _BTNIOCVALID(c) (_IOC_TYPE(c)==_BTNBASE)
|
||||
#define _BTNIOC(nr) _IOC(_BTNBASE,nr)
|
||||
|
||||
/* User LED driver ioctl definitions ****************************************/
|
||||
/* (see nuttx/discrete/userled.h */
|
||||
|
||||
#define _ULEDIOCVALID(c) (_IOC_TYPE(c)==_ULEDBASE)
|
||||
#define _ULEDIOC(nr) _IOC(_ULEDBASE,nr)
|
||||
|
||||
/* Zero Cross driver ioctl definitions **************************************/
|
||||
/* (see nuttx/include/sensor/zerocross.h */
|
||||
|
||||
|
||||
Reference in New Issue
Block a user