io-expander-pca9535a.h

Go to the documentation of this file.

#ifndef DRIVER_IO_EXPANDER_PCA9535A_H
#define DRIVER_IO_EXPANDER_PCA9535A_H
/**********************************************************************/
/*
 * Copyright (c) 2014, Jetro AS
 * 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. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONRIBUTORS ``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 AUTHOR 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.
 *
 * This file is part of the EVE platform.
 */

/**
 * \file
 * @brief Driver for I2C-based IO expander type NXP PCA9535A.
 *
 * @author KLO, Jetro as
 */ /******************************************************************/

#include <stdbool.h>
#include <string.h>
#include <em_device.h>

/**
 * This driver supports the I2C-based IO expander type NXP PCA9535A.
 * The IO expander has 2 8-bits IO ports, 1 open drain interrupt output and
 * 3 address lines.
 * The I2C address range is 0x20 - 0x27. Max baudrate is 400 kbit/s.
 * The port bits could be set to inputs or outputs individually, and
 * there are no pullups when used as inputs.
 *
 * Both initialization, writing to one or both ports and reading from
 * one or both ports are supported.
 *
 * The selected I2C port must be initialized before using the driver.
 */

/***********************************************************************
 * Global defines
***********************************************************************/
/**
 * io_expander_t structure holds I2C port and slave address to be used,
 * and the initial data for PORT0 and PORT1 for the IO expander.
 *
 */

struct io_expander_t
{
  const struct i2c_t *I2c;    // I2C port I2C0 or I2C1
  uint8_t SlaveAddress;       // I2C slave address 0x20 to 0x27
  uint8_t Port0Init;          // Initializes PORT0 IO pins (0 = logic low, 1 = logic high)
  uint8_t Port1Init;          // Initializes PORT1 IO pins (0 = logic low, 1 = logic high)
  uint8_t Port0Invert;        // Configures invertion of PORT0 input pins (0 = non-inverted, 1 = inverted)
  uint8_t Port1Invert;        // Configures invertion of PORT1 input pins (0 = non-inverted, 1 = inverted)
  uint8_t Port0Config;        // Configures the direction of PORT0 IO pins (0 = output, 1 = input)
  uint8_t Port1Config;        // Configures the direction of PORT1 IO pins (0 = output, 1 = input)
};

/**
  * @name Functions called from application programs
  * @{
  */

/**********************************************************************/
/**
 * @brief Name:       IoExpPortInit\n
 * Initializes I2C-based IO expander type NXP PCA9535A.
 * I2C address range is 0x20 - 0x27. Max baudrate is 400 kbit/s.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @return            true if OK, else false
 ***********************************************************************/
extern bool IoExpPortInit(const struct io_expander_t *IoExpander);

/**********************************************************************/
/**
 * @brief Name:       IoExpPortWrite\n
 * Write to IO expander PORT0 and PORT1.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @param Port0       Data to be written to PORT0
 * @param Port1       Data to be written to PORT1
 * @return            true if OK, else false
 ***********************************************************************/
extern bool IoExpPortWrite(const struct io_expander_t *IoExpander, const uint8_t Port0, const uint8_t Port1);

/**********************************************************************/
/**
 * @brief Name:       IoExpPort0Write\n
 * Write to IO expander PORT0.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @param Port0       Data to be written to PORT0
 * @return            true if OK, else false
 ***********************************************************************/
extern bool IoExpPort0Write(const struct io_expander_t *IoExpander, const uint8_t Port0);

/**********************************************************************/
/**
 * @brief Name:       IoExpPort1Write\n
 * Write to IO expander PORT1.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @param Port1       Data to be written to PORT1
 * @return            true if OK, else false
 ***********************************************************************/
extern bool IoExpPort1Write(const struct io_expander_t *IoExpander, const uint8_t Port1);

/**********************************************************************/
/**
 * @brief Name:       IoExpPortRead\n
 * Read IO expander PORT0 and PORT1.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @param Port0       Pointer to put data read from IO expander PORT0
 * @param Port1       Pointer to put data read from IO expander PORT1
 * @return            true if OK, else false
 ***********************************************************************/
extern bool IoExpPortRead(const struct io_expander_t *IoExpander, uint8_t *Port0, uint8_t *Port1);

/**********************************************************************/
/**
 * @brief Name:       IoExpPort0Read\n
 * Read IO expander PORT0.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @param Port0       Pointer to put data read from IO expander PORT0
 * @return            true if OK, else false
 ***********************************************************************/
static inline bool IoExpPort0Read(const struct io_expander_t *IoExpander, uint8_t *Port0)
{
  return IoExpPortRead(IoExpander, Port0, NULL);
}

/**********************************************************************/
/**
 * @brief Name: IoExpPort1Read\n
 * Read IO expander PORT1.
 *
 * @param IoExpander  Parameters for the IO port expander to be used
 * @param Port1       Pointer to put data read from IO expander PORT1
 * @return            true if OK, else false
 ***********************************************************************/
static inline bool IoExpPort1Read(const struct io_expander_t *IoExpander, uint8_t *Port1)
{
  return IoExpPortRead(IoExpander, NULL, Port1);
}

/** @} */
#endif //DRIVER_IO_EXPANDER_PCA9535A_H