sergiotarxz/nuttx
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

First (untested) cut at a TCA64XX I/O Expander driver leverages from Project Ara

Browse Source
This commit is contained in:
Gregory Nutt 2016-07-31 19:52:44 -06:00
parent 8fab9fb00f
commit c0b83cb4b4
5 changed files with 1815 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
drivers/ioexpander/Kconfig
View File

@ -40,15 +40,60 @@ config PCA9555_INT_ENABLE
config PCA9555_INT_NCALLBACKS
int "Max number of interrupt callbacks"
default 4
depends on IOEXPANDER_INT_ENABLE
depends on PCA9555_INT_ENABLE
---help---
This is the maximum number of interrupt callbacks supported
endif # IOEXPANDER_PCA9555
config IOEXPANDER_TCA64XX
bool "TCA64XX I2C IO expander"
default n
select I2C
depends on EXPERIMENTAL
---help---
Enable support for the NXP TCA64XX IO Expander
if IOEXPANDER_TCA64XX
config TCA64XX_MULTIPLE
bool "Multiple TCA64XX Devices"
default n
---help---
Can be defined to support multiple TCA64XX devices on board.
config TCA64XX_INT_ENABLE
bool "Enable TCA64XX Interrupt Support"
default n
select IOEXPANDER_INT_ENABLE
---help---
Enable driver interrupt functionality
config TCA64XX_INT_NCALLBACKS
int "Max number of interrupt callbacks"
default 4
depends on TCA64XX_INT_ENABLE
---help---
This is the maximum number of interrupt callbacks supported
config TCA64XX_INT_POLL
bool "Enable interrupt poll"
default n
---help---
Enable polling for missed interrupts.
config TCA64XX_INT_POLLDELAY
int "Interrupt poll delay (used)"
default 500000
depends on TCA64XX_INT_POLL
---help---
This microsecond delay defines the polling rate for missed interrupts.
endif # IOEXPANDER_TCA64XX
config IOEXPANDER_INT_ENABLE
bool
default y if PCA9555_INT_ENABLE
default n
---help---
This is the global INT supported flag for io expanders

4
drivers/ioexpander/Make.defs
View File

@ -43,6 +43,10 @@ ifeq ($(CONFIG_IOEXPANDER_PCA9555),y)
CSRCS += pca9555.c
endif
ifeq ($(CONFIG_IOEXPANDER_TCA64XX),y)
CSRCS += tca64xx.c
endif
endif # CONFIG_IOEXPANDER
# GPIO test device driver (independent of IOEXPANDERS)

1359
drivers/ioexpander/tca64xx.c Normal file
View File

File diff suppressed because it is too large Load Diff

267
drivers/ioexpander/tca64xx.h Normal file
View File

@ -0,0 +1,267 @@
/********************************************************************************************
* drivers/ioexpander/tca64.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_TCA64XX_H
#define __DRIVERS_IOEXPANDER_TCA64XX_H
/********************************************************************************************
* Included Files
********************************************************************************************/
#include <nuttx/config.h>
#include <semaphore.h>
#include <nuttx/wdog.h>
#include <nuttx/clock.h>
#include <nuttx/wqueue.h>
#include <nuttx/ioexpander/ioexpander.h>
#include <nuttx/ioexpander/tca64xx.h>
#include <nuttx/i2c/i2c_master.h>
#include <nuttx/irq.h>
#if defined(CONFIG_IOEXPANDER) && defined(CONFIG_IOEXPANDER_TCA64XX)
/********************************************************************************************
* Pre-processor Definitions
********************************************************************************************/
/* Configuration ****************************************************************************/
/* Prerequisites:
* CONFIG_I2C
* I2C support is required
* CONFIG_IOEXPANDER
* Enables I/O expander support
*
* Other settings that effect the driver: CONFIG_DISABLE_POLL
*
* CONFIG_IOEXPANDER_TCA64XX
* Enables support for the TCA64XX driver (Needs CONFIG_INPUT)
* CONFIG_TCA64XX_MULTIPLE
* Can be defined to support multiple TCA64XX devices on board.
* CONFIG_TCA64XX_INT_NCALLBACKS
* Maximum number of supported pin interrupt callbacks.
* CONFIG_TCA64XX_INT_POLL
* Enables a poll for missed interrupts
* CONFIG_TCA64XX_INT_POLLDELAY
* If CONFIG_TCA64XX_INT_POLL=y, then this is the delay in microseconds
* between polls for missed interrupts.
*/
#ifndef CONFIG_I2C
# error "CONFIG_I2C is required by TCA64XX"
#endif
#ifdef CONFIG_IOEXPANDER_INT_ENABLE
# ifndef CONFIG_TCA64XX_INT_NCALLBACKS
# define CONFIG_TCA64XX_INT_NCALLBACKS 4
# endif
#endif
#ifdef CONFIG_IOEXPANDER_INT_ENABLE
# ifndef CONFIG_SCHED_WORKQUEUE
# error Work queue support required. CONFIG_SCHED_WORKQUEUE must be selected.
# endif
#endif
#ifndef CONFIG_TCA64XX_INT_POLLDELAY
# define CONFIG_TCA64XX_INT_POLLDELAY 500000
#endif
/* TCA64XX Definitions **********************************************************************/
/* I2C frequency */
#define TCA64XX_I2C_MAXFREQUENCY 400000 /* 400KHz */
/* TCA64XX Parts ****************************************************************************/
#define TCA6408_INPUT_REG 0x00
#define TCA6408_OUTPUT_REG 0x01
#define TCA6408_POLARITY_REG 0x02
#define TCA6408_CONFIG_REG 0x03
#define TCA6408_NR_GPIOS 8
#define TCA6416_INPUT0_REG 0x00
#define TCA6416_INPUT1_REG 0x01
#define TCA6416_OUTPUT0_REG 0x02
#define TCA6416_OUTPUT1_REG 0x03
#define TCA6416_POLARITY0_REG 0x04
#define TCA6416_POLARITY1_REG 0x05
#define TCA6416_CONFIG0_REG 0x06
#define TCA6416_CONFIG1_REG 0x07
#define TCA6416_NR_GPIOS 16
#define TCA6424_INPUT0_REG 0x00
#define TCA6424_INPUT1_REG 0x01
#define TCA6424_INPUT2_REG 0x02
#define TCA6424_OUTPUT0_REG 0x04
#define TCA6424_OUTPUT1_REG 0x05
#define TCA6424_OUTPUT2_REG 0x06
#define TCA6424_POLARITY0_REG 0x08
#define TCA6424_POLARITY1_REG 0x09
#define TCA6424_POLARITY2_REG 0x0A
#define TCA6424_CONFIG0_REG 0x0C
#define TCA6424_CONFIG1_REG 0x0D
#define TCA6424_CONFIG2_REG 0x0E
#define TCA6424_NR_GPIOS 24
#define TCA64XX_NR_GPIO_MAX TCA6424_NR_GPIOS
/* 1us (datasheet: reset pulse duration (Tw) is 4ns */
#define TCA64XX_TW 1
/* 1us (datasheet: time to reset (Treset) is 600ns */
#define TCA64XX_TRESET 1
#define TCA64XX_IRQ_TYPE_EDGE_BOTH 0x00000000
#define TCA64XX_IRQ_TYPE_EDGE_RISING 0x00000001
#define TCA64XX_IRQ_TYPE_EDGE_FALLING 0x00000002
#define TCA64XX_IRQ_TYPE_LEVEL_HIGH 0x00000001
#define TCA64XX_IRQ_TYPE_LEVEL_LOW 0x00000002
#define TCA64XX_IRQ_TYPE_EDGE 0x00000000
#define TCA64XX_IRQ_TYPE_LEVEL 0x00000001
#define tca64xx_irq_type_is_level(handle, gpio) \
(tca64xx_get_gpio_triggering_type(handle, gpio) == TCA64XX_IRQ_TYPE_LEVEL)
#define tca64xx_irq_type_is_edge(handle, gpio) \
(tca64xx_get_gpio_triggering_type(handle, gpio) == TCA64XX_IRQ_TYPE_EDGE)
#define tca64xx_irq_edge_trigger_is_both(handle, gpio) \
(tca64xx_get_gpio_triggering_level(handle, gpio) == \
TCA64XX_IRQ_TYPE_EDGE_BOTH)
#define tca64xx_irq_edge_trigger_is_falling(handle, gpio) \
(tca64xx_get_gpio_triggering_level(handle, gpio) == \
TCA64XX_IRQ_TYPE_EDGE_FALLING)
#define tca64xx_irq_edge_trigger_is_rising(handle, gpio) \
(tca64xx_get_gpio_triggering_level(handle, gpio) == \
TCA64XX_IRQ_TYPE_EDGE_RISING)
#define tca64xx_irq_level_trigger_is_low(handle, gpio) \
(tca64xx_get_gpio_triggering_level(handle, gpio) == \
TCA64XX_IRQ_TYPE_LEVEL_LOW)
#define tca64xx_irq_level_trigger_is_high(handle, gpio) \
(tca64xx_get_gpio_triggering_level(handle, gpio) == \
TCA64XX_IRQ_TYPE_LEVEL_HIGH)
#define WORKER_DEFPRIO 50
#define WORKER_STACKSIZE 1024
#define TCA64XX_POLLDELAY (CONFIG_TCA64XX_INT_POLLDELAY / USEC_PER_TICK)
#define TCA64_LEVEL_SENSITIVE(d,p) \
(((d)->trigger & (1 << (p))) == 0)
#define TCA64_LEVEL_HIGH(d,p) \
(((d)->level[0] & (1 << (p))) != 0)
#define TCA64_LEVEL_LOW(d,p) \
(((d)->level[1] & (1 << (p))) != 0)
#define TCA64_EDGE_SENSITIVE(d,p) \
(((d)->trigger & (1 << (p))) != 0)
#define TCA64_EDGE_RISING(d,p) \
(((d)->level[0] & (1 << (p))) != 0)
#define TCA64_EDGE_FALLING(d,p) \
(((d)->level[1] & (1 << (p))) != 0)
#define TCA64_EDGE_BOTH(d,p) \
(TCA64_LEVEL_RISING(d,p) && TCA64_LEVEL_FALLING(d,p))
/********************************************************************************************
* Public Types
********************************************************************************************/
/* This structure represents the configuration of one part */
struct tca64_part_s
{
uint8_t tp_id; /* Part ID (see enum tca64xx_part_e) */
uint8_t tp_ngpios; /* Number of supported GPIOs */
uint8_t tp_input; /* Address of first input register */
uint8_t tp_output; /* Address of first output register */
uint8_t tp_polarity; /* Address of first polarity register */
uint8_t tp_config; /* Address of first configuration register */
};
#ifdef CONFIG_IOEXPANDER_INT_ENABLE
/* This type represents on registered pin interrupt callback */
struct tca64_callback_s
{
ioe_pinset_t pinset; /* Set of pin interrupts that will generate
* the callback. */
ioe_callback_t cbfunc; /* The saved callback function pointer */
};
#endif
/* This structure represents the state of the TCA64XX driver */
struct tca64_dev_s
{
struct ioexpander_dev_s dev; /* Nested structure to allow casting as public gpio
* expander. */
FAR struct tca64_config_s *config; /* Board configuration data */
FAR struct i2c_master_s *i2c; /* Saved I2C driver instance */
uint8_t part; /* TCA64xx part ID (see enum tca64xx_part_e) */
uint8_t addr; /* TCA64xx I2C address */
sem_t exclsem; /* Mutual exclusion */
#ifdef CONFIG_TCA64XX_INT_POLL
WDOG_ID wdog; /* Timer used to poll for missed interrupts */
#endif
#ifdef CONFIG_IOEXPANDER_INT_ENABLE
ioe_pinset_t input; /* Last input registeres */
ioe_pinset_t intstat; /* Pending interrupts */
ioe_pinset_t trigger; /* Bit encoded: 0=level 1=edge */
ioe_pinset_t level[2]; /* Bit encoded: 01=high/rising, 10 low/falling, 11 both */
struct work_s work; /* Supports the interrupt handling "bottom half" */
/* Saved callback information for each I/O expander client */
struct tca64_callback_s cb[CONFIG_TCA64XX_INT_NCALLBACKS];
#endif
};
#endif /* CONFIG_IOEXPANDER && CONFIG_IOEXPANDER_TCA64XX */
#endif /* __DRIVERS_IOEXPANDER_TCA64XX_H */

138
include/nuttx/ioexpander/tca64xx.h Normal file
View File

@ -0,0 +1,138 @@
/****************************************************************************
* include/nuttx/ioexpander/tca64xx.h
*
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* This header file derives, in part, from the Project Ara TCA64xx driver
* which has this copyright:
*
* Copyright (c) 2014-2015 Google Inc.
* All rights reserved.
*
* 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 of the copyright holder 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 HOLDER 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 _TSB_TCA64XX_H_
#define _TSB_TCA64XX_H_
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <stdint.h>
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Unused IO line for irq, reset. */
#define TCA64XX_IO_UNUSED (1 << 31)
/****************************************************************************
* Public Types
****************************************************************************/
/* Identifies supported TCA64xx parts (as well as the number of supported
* parts).
*/
enum tca64xx_part_e
{
TCA6408_PART = 0,
TCA6416_PART,
TCA6424_PART,
TCA64_NPARTS
};
#ifdef CONFIG_TCA64XX_INT_ENABLE
/* This is the type of the TCA64xx interrupt handler */
typedef CODE void (*tca64_handler_t)(FAR void *arg);
#endif
/* A reference to a structure of this type must be passed to the TCA64xx
* driver when the driver is instantiated. This structure provides
* information about the configuration of the TCA64xx and provides some
* board-specific hooks.
*
* Memory for this structure is provided by the caller. It is not copied by
* the driver and is presumed to persist while the driver is active. The
* memory must be writeable because, under certain circumstances, the driver
* may modify the frequency.
*/
struct tca64_config_s
{
/* Device characterization */
uint8_t address; /* 7-bit I2C address (only bits 0-6 used) */
uint8_t part; /* See enum tca64xx_part_e */
uint32_t frequency; /* I2C or SPI frequency */
#ifdef CONFIG_TCA64XX_INT_ENABLE
/* IRQ/GPIO access callbacks. These operations all hidden behind
* callbacks to isolate the TCA64xx driver from differences in GPIO
* interrupt handling by varying boards and MCUs.
*
* attach - Attach the TCA64xx interrupt handler to the GPIO interrupt
* enable - Enable or disable the GPIO interrupt
*/
CODE int (*attach)(FAR struct tca64_config_s *state,
tca64_handler_t handler, FAR void *arg);
CODE void (*enable)(FAR struct tca64_config_s *state, bool enable);
#endif
};
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
/****************************************************************************
* Name: tca64_initialize
*
* Description:
* Instantiate and configure the TCA64xx device driver to use the provided
* I2C device instance.
*
* Input Parameters:
* i2c - An I2C driver instance
* minor - The device i2c address
* config - Persistent board configuration data
*
* Returned Value:
* an ioexpander_dev_s instance on success, NULL on failure.
*
****************************************************************************/
struct i2c_master_s;
FAR struct ioexpander_dev_s *tca64_initialize(FAR struct i2c_master_s *i2c,
FAR struct tca64_config_s *config);
#endif