nuttx/drivers/ioexpander/pca9555.h

143 lines
5.4 KiB
C
Raw Normal View History

/********************************************************************************************
* drivers/ioexpander/pca9555.h
*
* Copyright (C) 2015 Gregory Nutt. All rights reserved.
* Author: Sebastien Lorquet <sebastien@lorquet.fr>
*
* References:
* "16-bit I2C-bus and SMBus I/O port with interrupt product datasheet",
* Rev. 08 - 22 October 2009, NXP
*
* 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 __DRIVERS_IOEXPANDER_PCA9555_H
#define __DRIVERS_IOEXPANDER_PCA9555_H
/********************************************************************************************
* Included Files
********************************************************************************************/
#include <nuttx/config.h>
#include <nuttx/wdog.h>
#include <nuttx/clock.h>
#include <nuttx/wqueue.h>
#include <nuttx/ioexpander/ioexpander.h>
#include <nuttx/ioexpander/pca9555.h>
#include <nuttx/i2c.h>
#include <nuttx/irq.h>
#if defined(CONFIG_IOEXPANDER) && defined(CONFIG_IOEXPANDER_PCA9555)
/********************************************************************************************
* Pre-processor Definitions
********************************************************************************************/
/* Configuration ****************************************************************************/
/* Prerequisites:
* CONFIG_I2C
* I2C support is required
* CONFIG_I2C_WRITEREAD
* Support for the I2C writeread method is required.
* CONFIG_IOEXPANDER
* Enables support for the PCA9555 I/O expander
*
* Other settings that effect the driver: CONFIG_DISABLE_POLL
*
* CONFIG_IOEXPANDER_PCA9555
* Enables support for the PCA9555 driver (Needs CONFIG_INPUT)
* CONFIG_PCA9555_MULTIPLE
* Can be defined to support multiple PCA9555 devices on board.
* CONFIG_PCA9555_INT_DISABLE
* Disable driver GPIO interrupt functionality (ignored if GPIO functionality is
* disabled).
*/
#undef CONFIG_PCA9555_REFCNT
/* Driver support ***************************************************************************/
/* This format is used to construct the /dev/input[n] device driver path. It defined here
* so that it will be used consistently in all places.
*/
/* PCA9555 Resources ************************************************************************/
#define PCA9555_GPIO_NPINS 16 /* All pins can be used as GPIOs */
#ifndef CONFIG_I2C
#error "CONFIG_I2C is required by PCA9555"
#endif
#ifndef CONFIG_PCA9555_INT_DISABLE
#ifndef CONFIG_SCHED_WORKQUEUE
#error "Work queue support required. CONFIG_SCHED_WORKQUEUE must be selected."
#endif
#endif
#define PCA9555_MAXDEVS 8
/* I2C frequency */
#define PCA9555_I2C_MAXFREQUENCY 400000 /* 400KHz */
/* PCA9555 Registers ************************************************************************/
/* Register Addresses */
#define PCA9555_REG_INPUT 0x00
#define PCA9555_REG_OUTPUT 0x02
#define PCA9555_REG_POLINV 0x04
#define PCA9555_REG_CONFIG 0x06
/********************************************************************************************
* Public Types
********************************************************************************************/
/* This structure represents the state of the PCA9555 driver */
struct pca9555_dev_s
{
struct ioexpander_dev_s dev; /* Nested structure to allow casting as public gpio expander. */
#ifdef CONFIG_PCA9555_MULTIPLE
FAR struct pca9555_dev_s *flink; /* Supports a singly linked list of drivers */
#endif
FAR struct pca9555_config_s *config; /* Board configuration data */
FAR struct i2c_dev_s *i2c; /* Saved I2C driver instance */
#ifndef CONFIG_PCA9555_INT_DISABLE
struct work_s work; /* Supports the interrupt handling "bottom half" */
pca9555_handler_t handlers[PCA9555_GPIO_NPINS]; /* GPIO "interrupt handlers" */
#endif
};
#endif /* CONFIG_IOEXPANDER && CONFIG_IOEXPANDER_PCA9555 */
#endif /* __DRIVERS_IOEXPANDER_PCA9555_H */