Espruino/targets/esp32/jshardwareI2c.c
2025-01-09 22:17:54 +00:00

184 lines
6.1 KiB
C

/*
* This file is designed to support i2c functions in Espruino,
* a JavaScript interpreter for Microcontrollers designed by Gordon Williams
*
* Copyright (C) 2016 by Rhys Williams (wilberforce)
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* ----------------------------------------------------------------------------
* This file is designed to be parsed during the build process
*
* Contains ESP32 board specific functions.
* ----------------------------------------------------------------------------
*/
#include "jshardware.h"
#include "jshardwareI2c.h"
#include "driver/i2c.h"
#include "stdio.h"
#include "jsinteractive.h"
#define ACK_CHECK_EN 0x1 /*!< I2C master will check ack from slave*/
#define ACK_CHECK_DIS 0x0 /*!< I2C master will not check ack from slave */
#define ACK_VAL 0x0 /*!< I2C ack value */
#define NACK_VAL 0x1 /*!< I2C nack value */
/* To do:
support both i2c ports - done
Test!
Stop bits param - bool sendStop
https://esp-idf.readthedocs.io/en/latest/api/i2c.html
*/
void jshSetDeviceInitialised(IOEventFlags device, bool isInit);
static esp_err_t checkError( char * caller, esp_err_t ret ) {
switch(ret) {
case ESP_OK: break;
case ESP_ERR_INVALID_ARG: {
jsExceptionHere(JSET_ERROR, "%s:, Parameter error", caller );
break;
}
case ESP_FAIL: {
jsExceptionHere(JSET_ERROR, "%s: slave doesn't ACK the transfer", caller);
break;
}
case ESP_ERR_TIMEOUT: {
jsExceptionHere(JSET_ERROR, "%s:, Operation timeout because the bus is busy", caller );
break;
}
default: {
jsExceptionHere(JSET_ERROR, "%s:, unknown error code %d", caller, ret );
break;
}
}
return ret;
}
void I2CReset(){
if(jshIsDeviceInitialised(EV_I2C1)){
i2c_driver_delete(I2C_NUM_0);
jshSetDeviceInitialised(EV_I2C1, false);
}
#if ESPR_I2C_COUNT>1
if(jshIsDeviceInitialised(EV_I2C2)){
i2c_driver_delete(I2C_NUM_1);
jshSetDeviceInitialised(EV_I2C2, false);
}
#endif
}
int getI2cFromDevice( IOEventFlags device ) {
switch(device) {
case EV_I2C1: return I2C_NUM_0;
#if ESPR_I2C_COUNT>1
case EV_I2C2: return I2C_NUM_1;
#endif
default: return -1;
}
}
/** Set-up I2C master for ESP32, default pins are target dependent, defined in board.py file
* Master mode only - handles I2C1 and I2C2 (if available eg on ESP32) */
void jshI2CSetup(IOEventFlags device, JshI2CInfo *info) {
int i2c_master_port = getI2cFromDevice(device);
if (i2c_master_port == -1) {
jsExceptionHere(JSET_ERROR,"Only I2C1 and I2C2 (if available on target) supported");
return;
}
if(jshIsDeviceInitialised(device)){
i2c_driver_delete(i2c_master_port);
}
JshPinFunction funcType = jshGetPinFunctionFromDevice(device);
if (!jshIsPinValid(info->pinSCL)) info->pinSCL = jshFindPinForFunction(funcType, JSH_I2C_SCL);
if (!jshIsPinValid(info->pinSDA)) info->pinSDA = jshFindPinForFunction(funcType, JSH_I2C_SDA);
#ifdef DEBUG
char funcTypeStr[50];
jshPinFunctionToString(funcType, JSPFTS_DEVICE | JSPFTS_DEVICE_NUMBER, funcTypeStr, sizeof(funcTypeStr));
jsDebug(DBG_INFO, "jshI2CSetup: I2C pins on device: %s, identified as sda: %d, scl: %d\n",
funcTypeStr, info->pinSDA, info->pinSCL);
#endif
i2c_config_t conf;
conf.mode = I2C_MODE_MASTER;
conf.sda_io_num = pinToESP32Pin(info->pinSDA);
conf.sda_pullup_en = GPIO_PULLUP_ENABLE;
conf.scl_io_num = pinToESP32Pin(info->pinSCL);
conf.scl_pullup_en = GPIO_PULLUP_ENABLE;
conf.master.clk_speed = info->bitrate;
#if defined(CONFIG_IDF_TARGET_ESP32C3) || defined(CONFIG_IDF_TARGET_ESP32S3) // added to resolve issue #2589 for IDF v4.x
conf.clk_flags = 0; // will always select 2MZ XTAL clock - Although speed set as in conf.master.clk_speed
// conf.clk_flags = 1; // or set driver to ignore XTAL clock and use 1MHz RTC clock (better for low power?)
// ref https://docs.espressif.com/projects/esp-idf/en/v4.4/esp32s3/api-reference/peripherals/i2c.html#source-clock-configuration
#endif
esp_err_t err=i2c_param_config(i2c_master_port, &conf);
if ( err == ESP_ERR_INVALID_ARG ) {
jsExceptionHere(JSET_ERROR,"jshI2CSetup: Invalid arguments");
return;
}
err=i2c_driver_install(i2c_master_port, conf.mode, 0, 0, 0);
if ( err == ESP_OK ) {
jsDebug(DBG_INFO, "jshI2CSetup: driver installed with, sda: %d scl: %d freq: %d, \n", info->pinSDA, info->pinSCL, conf.master.clk_speed);
jshSetDeviceInitialised(device, true);
} else {
checkError("jshI2CSetup",err);
}
}
void jshI2CWrite(IOEventFlags device,
unsigned char address,
int nBytes,
const unsigned char *data,
bool sendStop) {
int i2c_master_port = getI2cFromDevice(device);
if (i2c_master_port == -1) {
jsExceptionHere(JSET_ERROR,"Only I2C1 and I2C2 supported");
return;
}
esp_err_t ret;
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
ret=i2c_master_start(cmd);
ret=i2c_master_write_byte(cmd, address << 1 | I2C_MASTER_WRITE, ACK_CHECK_EN);
ret=i2c_master_write(cmd, data, nBytes, ACK_CHECK_EN);
if ( sendStop ) ret=i2c_master_stop(cmd);
ret = i2c_master_cmd_begin(i2c_master_port, cmd, 1000 / portTICK_RATE_MS); // 1000 seems very large for ticks_to_wait???
i2c_cmd_link_delete(cmd);
checkError( "jshI2CWrite", ret);
}
void jshI2CRead(IOEventFlags device,
unsigned char address,
int nBytes,
unsigned char *data,
bool sendStop) {
if (nBytes <= 0) {
return;
}
int i2c_master_port = getI2cFromDevice(device);
if (i2c_master_port == -1) {
jsExceptionHere(JSET_ERROR,"Only I2C1 and I2C2 supported");
return;
}
esp_err_t ret;
i2c_cmd_handle_t cmd = i2c_cmd_link_create();
ret=i2c_master_start(cmd);
ret=i2c_master_write_byte(cmd, ( address << 1 ) | I2C_MASTER_READ, ACK_CHECK_EN);
if (nBytes > 1) {
ret=i2c_master_read(cmd, data, nBytes - 1, ACK_VAL);
}
ret=i2c_master_read_byte(cmd, data + nBytes - 1, NACK_VAL);
if ( sendStop ) ret=i2c_master_stop(cmd);
ret = i2c_master_cmd_begin(i2c_master_port, cmd, 1000 / portTICK_RATE_MS);
i2c_cmd_link_delete(cmd);
checkError( "jshI2CRead", ret);
}