243 lines
9.2 KiB
C
Executable File
243 lines
9.2 KiB
C
Executable File
/**
|
|
* @file zh_mcp23s17.h
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "esp_log.h"
|
|
#include "driver/gpio.h"
|
|
#include "driver/spi_master.h"
|
|
#include "freertos/FreeRTOS.h"
|
|
#include "freertos/task.h"
|
|
#include "esp_event.h"
|
|
#include "zh_vector.h"
|
|
|
|
#define ZH_MCP23S17_GPIO_OUTPUT false
|
|
#define ZH_MCP23S17_GPIO_INPUT true
|
|
#define ZH_MCP23S17_GPIO_LOW false
|
|
#define ZH_MCP23S17_GPIO_HIGH true
|
|
//eee
|
|
|
|
/**
|
|
* @brief MCP23S17 expander initial default values.
|
|
*/
|
|
#define ZH_MCP23S17_INIT_CONFIG_DEFAULT() \
|
|
{ \
|
|
.task_priority = 1, \
|
|
.stack_size = configMINIMAL_STACK_SIZE, \
|
|
.gpa0_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa1_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa2_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa3_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa4_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa5_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa6_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpa7_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb0_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb1_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb2_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb3_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb4_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb5_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb6_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.gpb7_gpio_work_mode = ZH_MCP23S17_GPIO_OUTPUT, \
|
|
.cs_gpio = GPIO_NUM_MAX, \
|
|
.interrupt_gpio = GPIO_NUM_MAX}
|
|
|
|
#ifdef __cplusplus
|
|
extern "C"
|
|
{
|
|
#endif
|
|
|
|
extern TaskHandle_t zh_mcp23s17; /*!< Unique task handle. */
|
|
|
|
/**
|
|
* @brief Enumeration of MCP23S17 expander GPIO.
|
|
*/
|
|
typedef enum
|
|
{
|
|
ZH_MCP23S17_GPIO_NUM_GPA0 = 0,
|
|
ZH_MCP23S17_GPIO_NUM_GPA1,
|
|
ZH_MCP23S17_GPIO_NUM_GPA2,
|
|
ZH_MCP23S17_GPIO_NUM_GPA3,
|
|
ZH_MCP23S17_GPIO_NUM_GPA4,
|
|
ZH_MCP23S17_GPIO_NUM_GPA5,
|
|
ZH_MCP23S17_GPIO_NUM_GPA6,
|
|
ZH_MCP23S17_GPIO_NUM_GPA7,
|
|
ZH_MCP23S17_GPIO_NUM_GPB0,
|
|
ZH_MCP23S17_GPIO_NUM_GPB1,
|
|
ZH_MCP23S17_GPIO_NUM_GPB2,
|
|
ZH_MCP23S17_GPIO_NUM_GPB3,
|
|
ZH_MCP23S17_GPIO_NUM_GPB4,
|
|
ZH_MCP23S17_GPIO_NUM_GPB5,
|
|
ZH_MCP23S17_GPIO_NUM_GPB6,
|
|
ZH_MCP23S17_GPIO_NUM_GPB7,
|
|
ZH_MCP23S17_GPIO_NUM_MAX
|
|
} zh_mcp23s17_gpio_num_t;
|
|
|
|
/**
|
|
* @brief Structure for initial initialization of MCP23S17 expander.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t task_priority; /*!< Task priority for the MCP23S17 expander isr processing. @note Minimum value is 1. */
|
|
uint16_t stack_size; /*!< Stack size for task for the MCP23S17 expander isr processing processing. @note The minimum size is configMINIMAL_STACK_SIZE. */
|
|
uint8_t cs_gpio; /*!< CS GPIO. */
|
|
bool gpa0_gpio_work_mode; /*!< Expander GPIO GPAO work mode. */
|
|
bool gpa1_gpio_work_mode; /*!< Expander GPIO GPA1 work mode. */
|
|
bool gpa2_gpio_work_mode; /*!< Expander GPIO GPA2 work mode. */
|
|
bool gpa3_gpio_work_mode; /*!< Expander GPIO GPA3 work mode. */
|
|
bool gpa4_gpio_work_mode; /*!< Expander GPIO GPA4 work mode. */
|
|
bool gpa5_gpio_work_mode; /*!< Expander GPIO GPA5 work mode. */
|
|
bool gpa6_gpio_work_mode; /*!< Expander GPIO GPA6 work mode. */
|
|
bool gpa7_gpio_work_mode; /*!< Expander GPIO GPA7 work mode. */
|
|
bool gpb0_gpio_work_mode; /*!< Expander GPIO GPBO work mode. */
|
|
bool gpb1_gpio_work_mode; /*!< Expander GPIO GPB1 work mode. */
|
|
bool gpb2_gpio_work_mode; /*!< Expander GPIO GPB2 work mode. */
|
|
bool gpb3_gpio_work_mode; /*!< Expander GPIO GPB3 work mode. */
|
|
bool gpb4_gpio_work_mode; /*!< Expander GPIO GPB4 work mode. */
|
|
bool gpb5_gpio_work_mode; /*!< Expander GPIO GPB5 work mode. */
|
|
bool gpb6_gpio_work_mode; /*!< Expander GPIO GPB6 work mode. */
|
|
bool gpb7_gpio_work_mode; /*!< Expander GPIO GPB7 work mode. */
|
|
uint8_t interrupt_gpio; /*!< Interrupt GPIO. @attention Must be same for all MCP23S17 expanders. */
|
|
uint8_t spi_host; /*!< SPI host. @attention Must be same for all MCP23S17 expanders. */
|
|
} zh_mcp23s17_init_config_t;
|
|
|
|
/**
|
|
* @brief MCP23S17 expander handle.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t cs_gpio; /*!< CS GPIO. */
|
|
uint16_t gpio_work_mode; /*!< Expander GPIO's work mode. */
|
|
uint16_t gpio_status; /*!< Expander GPIO's status. */
|
|
bool is_initialized; /*!< Expander initialization flag. */
|
|
spi_device_handle_t spi_handle; /*!< Unique SPI device handle. */
|
|
void *system; /*!< System pointer for use in another components. */
|
|
} zh_mcp23s17_handle_t;
|
|
|
|
/**
|
|
* @brief Structure for error statistics storage.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint32_t spi_driver_error; /*!< Number of SPI driver error. */
|
|
uint32_t event_post_error; /*!< Number of event post error. */
|
|
uint32_t vector_error; /*!< Number of vector error. */
|
|
uint32_t queue_overflow_error; /*!< Number of queue overflow error. */
|
|
uint32_t min_stack_size; /*!< Minimum free stack size. */
|
|
} zh_mcp23s17_stats_t;
|
|
|
|
ESP_EVENT_DECLARE_BASE(ZH_MCP23S17);
|
|
|
|
/**
|
|
* @brief Structure for sending data to the event handler when cause an interrupt.
|
|
*
|
|
* @note Should be used with ZH_MCP23S17 event base.
|
|
*/
|
|
typedef struct
|
|
{
|
|
uint8_t cs_gpio; /*!< The CS GPIO of MCP23S17 expander that caused the interrupt. */
|
|
uint8_t gpio_number; /*!< The GPIO that caused the interrupt. */
|
|
bool gpio_level; /*!< The GPIO level that caused the interrupt. */
|
|
} zh_mcp23s17_event_on_isr_t;
|
|
|
|
/**
|
|
* @brief Initialize MCP23S17 expander.
|
|
*
|
|
* @param[in] config Pointer to MCP23S17 initialized configuration structure. Can point to a temporary variable.
|
|
* @param[out] handle Pointer to unique MCP23S17 handle.
|
|
*
|
|
* @attention SPI driver must be initialized first.
|
|
*
|
|
* @note Before initialize the expander recommend initialize zh_mcp23s17_init_config_t structure with default values.
|
|
*
|
|
* @code zh_mcp23s17_init_config_t config = ZH_MCP23S17_INIT_CONFIG_DEFAULT() @endcode
|
|
*
|
|
* @return ESP_OK if success or an error code otherwise.
|
|
*/
|
|
esp_err_t zh_mcp23s17_init(const zh_mcp23s17_init_config_t *config, zh_mcp23s17_handle_t *handle);
|
|
|
|
// /**
|
|
// * @brief Deinitialize PCF8574 expander.
|
|
// *
|
|
// * @param[in] handle Pointer to unique PCF8574 handle.
|
|
// *
|
|
// * @return ESP_OK if success or an error code otherwise.
|
|
// */
|
|
// esp_err_t zh_pcf8574_deinit(zh_pcf8574_handle_t *handle);
|
|
|
|
// /**
|
|
// * @brief Read PCF8574 all GPIO's status.
|
|
// *
|
|
// * @param[in] handle Pointer to unique PCF8574 handle.
|
|
// * @param[out] reg Pointer to GPIO's status.
|
|
// *
|
|
// * @note For input GPIO's status will be 1 (HIGH) always.
|
|
// *
|
|
// * @return ESP_OK if success or an error code otherwise.
|
|
// */
|
|
// esp_err_t zh_pcf8574_read(zh_pcf8574_handle_t *handle, uint8_t *reg);
|
|
|
|
// /**
|
|
// * @brief Set PCF8574 all GPIO's status.
|
|
// *
|
|
// * @param[in] handle Pointer to unique PCF8574 handle.
|
|
// * @param[in] reg GPIO's status.
|
|
// *
|
|
// * @attention Only the GPIO outputs are affected.
|
|
// *
|
|
// * @return ESP_OK if success or an error code otherwise.
|
|
// */
|
|
// esp_err_t zh_pcf8574_write(zh_pcf8574_handle_t *handle, uint8_t reg);
|
|
|
|
// /**
|
|
// * @brief Reset (set to initial) PCF8574 all GPIO's.
|
|
// *
|
|
// * @param[in] handle Pointer to unique PCF8574 handle.
|
|
// *
|
|
// * @return ESP_OK if success or an error code otherwise.
|
|
// */
|
|
// esp_err_t zh_pcf8574_reset(zh_pcf8574_handle_t *handle);
|
|
|
|
// /**
|
|
// * @brief Read PCF8574 GPIO status.
|
|
// *
|
|
// * @param[in] handle Pointer to unique PCF8574 handle.
|
|
// * @param[in] gpio GPIO number.
|
|
// * @param[out] status Pointer to GPIO status (true - HIGH, false - LOW).
|
|
// *
|
|
// * @note For input GPIO's status will be 1 (HIGH) always.
|
|
// *
|
|
// * @return ESP_OK if success or an error code otherwise.
|
|
// */
|
|
// esp_err_t zh_pcf8574_read_gpio(zh_pcf8574_handle_t *handle, ZH_MCP23S17_GPIO_num_t gpio, bool *status);
|
|
|
|
// /**
|
|
// * @brief Set PCF8574 GPIO status.
|
|
// *
|
|
// * @param[in] handle Pointer to unique PCF8574 handle.
|
|
// * @param[in] gpio GPIO number.
|
|
// * @param[in] status GPIO status (true - HIGH, false - LOW).
|
|
// *
|
|
// * @attention Only the GPIO output is affected.
|
|
// *
|
|
// * @return ESP_OK if success or an error code otherwise.
|
|
// */
|
|
// esp_err_t zh_pcf8574_write_gpio(zh_pcf8574_handle_t *handle, ZH_MCP23S17_GPIO_num_t gpio, bool status);
|
|
|
|
// /**
|
|
// * @brief Get error statistics.
|
|
// *
|
|
// * @return Pointer to the statistics structure.
|
|
// */
|
|
// const zh_pcf8574_stats_t *zh_pcf8574_get_stats(void);
|
|
|
|
// /**
|
|
// * @brief Reset error statistics.
|
|
// */
|
|
// void zh_pcf8574_reset_stats(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif |