walnux/drivers/ioexpander/pca9557.h
wangjianyu3 b73d7f2922 drivers/ioexpander: Add support for PCA9557
Datasheet: https://www.ti.com/lit/ds/symlink/pca9557.pdf

Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2025-03-25 15:46:09 -03:00

96 lines
3.4 KiB
C

/****************************************************************************
* drivers/ioexpander/pca9557.h
*
* SPDX-License-Identifier: Apache-2.0
*
* 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 __DRIVERS_IOEXPANDER_PCA9557_H
#define __DRIVERS_IOEXPANDER_PCA9557_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <nuttx/wdog.h>
#include <nuttx/clock.h>
#include <nuttx/mutex.h>
#include <nuttx/wqueue.h>
#include <nuttx/ioexpander/ioexpander.h>
#include <nuttx/ioexpander/pca9557.h>
#include <nuttx/i2c/i2c_master.h>
#include <nuttx/irq.h>
#if defined(CONFIG_IOEXPANDER) && defined(CONFIG_IOEXPANDER_PCA9557)
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Configuration ************************************************************/
/* Prerequisites:
* CONFIG_I2C
* I2C support is required
* CONFIG_IOEXPANDER
* Enables support for the PCA9557 I/O expander
*
* CONFIG_IOEXPANDER_PCA9557
* Enables support for the PCA9557 driver (Needs CONFIG_INPUT)
*/
/* PCA9557 Resources ********************************************************/
#define PCA9557_GPIO_NPINS 8
#define PCA9557_MAXDEVS 8
/* I2C frequency */
#define PCA9557_I2C_MAXFREQUENCY 400000 /* 400KHz */
/* PCA9557 Registers ********************************************************/
#define PCA9557_REG_NUM 4
#define PCA9557_REG_INPUT 0x00
#define PCA9557_REG_OUTPUT 0x01
#define PCA9557_REG_POLINV 0x02
#define PCA9557_REG_CONFIG 0x03
/****************************************************************************
* Public Types
****************************************************************************/
/* This structure represents the state of the PCA9557 driver */
struct pca9557_dev_s
{
struct ioexpander_dev_s dev; /* Nested structure to allow casting
* as public gpio expander. */
#ifdef CONFIG_PCA9557_SHADOW_MODE
uint8_t sreg[PCA9557_REG_NUM]; /* Shadowed registers */
#endif
FAR struct pca9557_config_s *config; /* Board configuration data */
FAR struct i2c_master_s *i2c; /* Saved I2C driver instance */
rmutex_t lock; /* Mutual exclusion */
};
#endif /* CONFIG_IOEXPANDER && CONFIG_IOEXPANDER_PCA9557 */
#endif /* __DRIVERS_IOEXPANDER_PCA9557_H */