esp32-hal-periman.c

/*
 * SPDX-FileCopyrightText: 2019-2023 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include"esp32-hal-log.h"
#include"esp32-hal-periman.h"
#include"esp_bit_defs.h"

typedefstructATTR_PACKED {
peripheral_bus_type_ttype;
constchar*extra_type;
void*bus;
int8_tbus_num;
int8_tbus_channel;
} peripheral_pin_item_t;

staticperipheral_bus_deinit_cb_tdeinit_functions[ESP32_BUS_TYPE_MAX];
staticperipheral_pin_item_tpins[SOC_GPIO_PIN_COUNT];

#defineGPIO_NOT_VALID(p) ((p >= SOC_GPIO_PIN_COUNT) || ((SOC_GPIO_VALID_GPIO_MASK & (1ULL << p)) == 0))

constchar*perimanGetTypeName(peripheral_bus_type_ttype) {
switch (type) {
caseESP32_BUS_TYPE_INIT: return"INIT";
caseESP32_BUS_TYPE_GPIO: return"GPIO";
caseESP32_BUS_TYPE_UART_RX: return"UART_RX";
caseESP32_BUS_TYPE_UART_TX: return"UART_TX";
caseESP32_BUS_TYPE_UART_CTS: return"UART_CTS";
caseESP32_BUS_TYPE_UART_RTS: return"UART_RTS";
#ifSOC_SDM_SUPPORTED
caseESP32_BUS_TYPE_SIGMADELTA: return"SIGMADELTA";
#endif
#ifSOC_ADC_SUPPORTED
caseESP32_BUS_TYPE_ADC_ONESHOT: return"ADC_ONESHOT";
caseESP32_BUS_TYPE_ADC_CONT: return"ADC_CONT";
#endif
#ifSOC_DAC_SUPPORTED
caseESP32_BUS_TYPE_DAC_ONESHOT: return"DAC_ONESHOT";
caseESP32_BUS_TYPE_DAC_CONT: return"DAC_CONT";
caseESP32_BUS_TYPE_DAC_COSINE: return"DAC_COSINE";
#endif
#ifSOC_LEDC_SUPPORTED
caseESP32_BUS_TYPE_LEDC: return"LEDC";
#endif
#ifSOC_RMT_SUPPORTED
caseESP32_BUS_TYPE_RMT_TX: return"RMT_TX";
caseESP32_BUS_TYPE_RMT_RX: return"RMT_RX";
#endif
#ifSOC_I2S_SUPPORTED
caseESP32_BUS_TYPE_I2S_STD_MCLK: return"I2S_STD_MCLK";
caseESP32_BUS_TYPE_I2S_STD_BCLK: return"I2S_STD_BCLK";
caseESP32_BUS_TYPE_I2S_STD_WS: return"I2S_STD_WS";
caseESP32_BUS_TYPE_I2S_STD_DOUT: return"I2S_STD_DOUT";
caseESP32_BUS_TYPE_I2S_STD_DIN: return"I2S_STD_DIN";
caseESP32_BUS_TYPE_I2S_TDM_MCLK: return"I2S_TDM_MCLK";
caseESP32_BUS_TYPE_I2S_TDM_BCLK: return"I2S_TDM_BCLK";
caseESP32_BUS_TYPE_I2S_TDM_WS: return"I2S_TDM_WS";
caseESP32_BUS_TYPE_I2S_TDM_DOUT: return"I2S_TDM_DOUT";
caseESP32_BUS_TYPE_I2S_TDM_DIN: return"I2S_TDM_DIN";
caseESP32_BUS_TYPE_I2S_PDM_TX_CLK: return"I2S_PDM_TX_CLK";
caseESP32_BUS_TYPE_I2S_PDM_TX_DOUT0: return"I2S_PDM_TX_DOUT0";
caseESP32_BUS_TYPE_I2S_PDM_TX_DOUT1: return"I2S_PDM_TX_DOUT1";
caseESP32_BUS_TYPE_I2S_PDM_RX_CLK: return"I2S_PDM_RX_CLK";
caseESP32_BUS_TYPE_I2S_PDM_RX_DIN0: return"I2S_PDM_RX_DIN0";
caseESP32_BUS_TYPE_I2S_PDM_RX_DIN1: return"I2S_PDM_RX_DIN1";
caseESP32_BUS_TYPE_I2S_PDM_RX_DIN2: return"I2S_PDM_RX_DIN2";
caseESP32_BUS_TYPE_I2S_PDM_RX_DIN3: return"I2S_PDM_RX_DIN3";
#endif
#ifSOC_I2C_SUPPORTED
caseESP32_BUS_TYPE_I2C_MASTER_SDA: return"I2C_MASTER_SDA";
caseESP32_BUS_TYPE_I2C_MASTER_SCL: return"I2C_MASTER_SCL";
caseESP32_BUS_TYPE_I2C_SLAVE_SDA: return"I2C_SLAVE_SDA";
caseESP32_BUS_TYPE_I2C_SLAVE_SCL: return"I2C_SLAVE_SCL";
#endif
#ifSOC_GPSPI_SUPPORTED
caseESP32_BUS_TYPE_SPI_MASTER_SCK: return"SPI_MASTER_SCK";
caseESP32_BUS_TYPE_SPI_MASTER_MISO: return"SPI_MASTER_MISO";
caseESP32_BUS_TYPE_SPI_MASTER_MOSI: return"SPI_MASTER_MOSI";
caseESP32_BUS_TYPE_SPI_MASTER_SS: return"SPI_MASTER_SS";
#endif
#ifSOC_SDMMC_HOST_SUPPORTED
caseESP32_BUS_TYPE_SDMMC_CLK: return"SDMMC_CLK";
caseESP32_BUS_TYPE_SDMMC_CMD: return"SDMMC_CMD";
caseESP32_BUS_TYPE_SDMMC_D0: return"SDMMC_D0";
caseESP32_BUS_TYPE_SDMMC_D1: return"SDMMC_D1";
caseESP32_BUS_TYPE_SDMMC_D2: return"SDMMC_D2";
caseESP32_BUS_TYPE_SDMMC_D3: return"SDMMC_D3";
#endif
#ifSOC_TOUCH_SENSOR_SUPPORTED
caseESP32_BUS_TYPE_TOUCH: return"TOUCH";
#endif
#ifSOC_USB_SERIAL_JTAG_SUPPORTED||SOC_USB_OTG_SUPPORTED
caseESP32_BUS_TYPE_USB_DM: return"USB_DM";
caseESP32_BUS_TYPE_USB_DP: return"USB_DP";
#endif
#ifSOC_GPSPI_SUPPORTED
caseESP32_BUS_TYPE_ETHERNET_SPI: return"ETHERNET_SPI";
#endif
#ifCONFIG_ETH_USE_ESP32_EMAC
caseESP32_BUS_TYPE_ETHERNET_RMII: return"ETHERNET_RMII";
caseESP32_BUS_TYPE_ETHERNET_CLK: return"ETHERNET_CLK";
caseESP32_BUS_TYPE_ETHERNET_MCD: return"ETHERNET_MCD";
caseESP32_BUS_TYPE_ETHERNET_MDIO: return"ETHERNET_MDIO";
caseESP32_BUS_TYPE_ETHERNET_PWR: return"ETHERNET_PWR";
#endif
#ifCONFIG_LWIP_PPP_SUPPORT
caseESP32_BUS_TYPE_PPP_TX: return"PPP_MODEM_TX";
caseESP32_BUS_TYPE_PPP_RX: return"PPP_MODEM_RX";
caseESP32_BUS_TYPE_PPP_RTS: return"PPP_MODEM_RTS";
caseESP32_BUS_TYPE_PPP_CTS: return"PPP_MODEM_CTS";
#endif
default: return"UNKNOWN";
 }
}

boolperimanSetPinBus(uint8_tpin, peripheral_bus_type_ttype, void*bus, int8_tbus_num, int8_tbus_channel) {
peripheral_bus_type_totype=ESP32_BUS_TYPE_INIT;
void*obus=NULL;
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
return false;
 }
if (type >= ESP32_BUS_TYPE_MAX) {
log_e("Invalid type: %s (%u) when setting pin %u", perimanGetTypeName(type), (unsigned int)type, pin);
return false;
 }
if (type>ESP32_BUS_TYPE_GPIO&&bus==NULL) {
log_e("Bus is NULL for pin %u with type %s (%u)", pin, perimanGetTypeName(type), (unsigned int)type);
return false;
 }
if (type==ESP32_BUS_TYPE_INIT&&bus!=NULL) {
log_e("Can't set a Bus to INIT Type (pin %u)", pin);
return false;
 }
otype=pins[pin].type;
obus=pins[pin].bus;
if (type==otype&&bus==obus) {
if (type!=ESP32_BUS_TYPE_INIT) {
log_i("Pin %u already has type %s (%u) with bus %p", pin, perimanGetTypeName(type), (unsigned int)type, bus);
 }
return true;
 }
if (obus!=NULL) {
if (deinit_functions[otype] ==NULL) {
log_e("No deinit function for type %s (%u) (pin %u)", perimanGetTypeName(otype), (unsigned int)otype, pin);
return false;
 }
if (!deinit_functions[otype](obus)) {
log_e("Deinit function for previous bus type %s (%u) failed (pin %u)", perimanGetTypeName(otype), (unsigned int)otype, pin);
return false;
 }
 }
pins[pin].type=type;
pins[pin].bus=bus;
pins[pin].bus_num=bus_num;
pins[pin].bus_channel=bus_channel;
pins[pin].extra_type=NULL;
log_v("Pin %u successfully set to type %s (%u) with bus %p", pin, perimanGetTypeName(type), (unsigned int)type, bus);
return true;
}

boolperimanSetPinBusExtraType(uint8_tpin, constchar*extra_type) {
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
return false;
 }
if (pins[pin].type==ESP32_BUS_TYPE_INIT) {
log_e("Can't set extra type for Bus INIT Type (pin %u)", pin);
return false;
 }
pins[pin].extra_type=extra_type;
log_v("Successfully set extra_type %s for pin %u", extra_type, pin);
return true;
}

void*perimanGetPinBus(uint8_tpin, peripheral_bus_type_ttype) {
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
returnNULL;
 }
if (type >= ESP32_BUS_TYPE_MAX||type==ESP32_BUS_TYPE_INIT) {
log_e("Invalid type %s (%u) for pin %u", perimanGetTypeName(type), (unsigned int)type, pin);
returnNULL;
 }
if (pins[pin].type==type) {
returnpins[pin].bus;
 }
returnNULL;
}

peripheral_bus_type_tperimanGetPinBusType(uint8_tpin) {
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
returnESP32_BUS_TYPE_MAX;
 }
returnpins[pin].type;
}

constchar*perimanGetPinBusExtraType(uint8_tpin) {
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
returnNULL;
 }
returnpins[pin].extra_type;
}

int8_tperimanGetPinBusNum(uint8_tpin) {
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
return-1;
 }
returnpins[pin].bus_num;
}

int8_tperimanGetPinBusChannel(uint8_tpin) {
if (GPIO_NOT_VALID(pin)) {
log_e("Invalid pin: %u", pin);
return-1;
 }
returnpins[pin].bus_channel;
}

boolperimanSetBusDeinit(peripheral_bus_type_ttype, peripheral_bus_deinit_cb_tcb) {
if (type >= ESP32_BUS_TYPE_MAX||type==ESP32_BUS_TYPE_INIT) {
log_e("Invalid type: %s (%u)", perimanGetTypeName(type), (unsigned int)type);
return false;
 }
if (cb==NULL) {
log_e("Callback is NULL when setting deinit function for type %s (%u)", perimanGetTypeName(type), (unsigned int)type);
return false;
 }
deinit_functions[type] =cb;
log_v("Deinit function for type %s (%u) successfully set to %p", perimanGetTypeName(type), (unsigned int)type, cb);
return true;
}

boolperimanPinIsValid(uint8_tpin) {
return !(GPIO_NOT_VALID(pin));
}