gpio_exp.c 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710
  1. /* GDS Example
  2. This example code is in the Public Domain (or CC0 licensed, at your option.)
  3. Unless required by applicable law or agreed to in writing, this
  4. software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
  5. CONDITIONS OF ANY KIND, either express or implied.
  6. */
  7. #include <string.h>
  8. #include <stdlib.h>
  9. #include "freertos/FreeRTOS.h"
  10. #include "freertos/task.h"
  11. #include "freertos/timers.h"
  12. #include "freertos/queue.h"
  13. #include "esp_task.h"
  14. #include "esp_log.h"
  15. #include "driver/gpio.h"
  16. #include "driver/i2c.h"
  17. #include "driver/spi_master.h"
  18. #include "gpio_exp.h"
  19. #define GPIO_EXP_INTR 0x100
  20. #define GPIO_EXP_WRITE 0x200
  21. /*
  22. shadow register is both output and input, so we assume that reading to the
  23. ports also reads the value set on output
  24. */
  25. typedef struct gpio_exp_s {
  26. uint32_t first, last;
  27. struct {
  28. struct gpio_exp_phy_s phy;
  29. spi_device_handle_t spi_handle;
  30. };
  31. uint32_t shadow, pending;
  32. TickType_t age;
  33. SemaphoreHandle_t mutex;
  34. uint32_t r_mask, w_mask;
  35. uint32_t pullup, pulldown;
  36. struct gpio_exp_isr_s {
  37. gpio_isr_t handler;
  38. void *arg;
  39. TimerHandle_t timer;
  40. } isr[32];
  41. struct gpio_exp_model_s const *model;
  42. } gpio_exp_t;
  43. typedef struct {
  44. enum { ASYNC_WRITE } type;
  45. int gpio;
  46. int level;
  47. gpio_exp_t *expander;
  48. } queue_request_t;
  49. static const char TAG[] = "gpio expander";
  50. static void IRAM_ATTR intr_isr_handler(void* arg);
  51. static gpio_exp_t* find_expander(gpio_exp_t *expander, int *gpio);
  52. static void pca9535_set_direction(gpio_exp_t* self);
  53. static int pca9535_read(gpio_exp_t* self);
  54. static void pca9535_write(gpio_exp_t* self);
  55. static void pca85xx_set_direction(gpio_exp_t* self);
  56. static int pca85xx_read(gpio_exp_t* self);
  57. static void pca85xx_write(gpio_exp_t* self);
  58. static esp_err_t mcp23017_init(gpio_exp_t* self);
  59. static void mcp23017_set_pull_mode(gpio_exp_t* self);
  60. static void mcp23017_set_direction(gpio_exp_t* self);
  61. static int mcp23017_read(gpio_exp_t* self);
  62. static void mcp23017_write(gpio_exp_t* self);
  63. static esp_err_t mcp23s17_init(gpio_exp_t* self);
  64. static void mcp23s17_set_pull_mode(gpio_exp_t* self);
  65. static void mcp23s17_set_direction(gpio_exp_t* self);
  66. static int mcp23s17_read(gpio_exp_t* self);
  67. static void mcp23s17_write(gpio_exp_t* self);
  68. static void service_handler(void *arg);
  69. static void debounce_handler( TimerHandle_t xTimer );
  70. static esp_err_t i2c_write(uint8_t port, uint8_t addr, uint8_t reg, uint32_t data, int len);
  71. static uint32_t i2c_read(uint8_t port, uint8_t addr, uint8_t reg, int len);
  72. static spi_device_handle_t spi_config(struct gpio_exp_phy_s *phy);
  73. static esp_err_t spi_write(spi_device_handle_t handle, uint8_t addr, uint8_t reg, uint32_t data, int len);
  74. static uint32_t spi_read(spi_device_handle_t handle, uint8_t addr, uint8_t reg, int len);
  75. static const struct gpio_exp_model_s {
  76. char *model;
  77. gpio_int_type_t trigger;
  78. esp_err_t (*init)(gpio_exp_t* self);
  79. int (*read)(gpio_exp_t* self);
  80. void (*write)(gpio_exp_t* self);
  81. void (*set_direction)(gpio_exp_t* self);
  82. void (*set_pull_mode)(gpio_exp_t* self);
  83. } registered[] = {
  84. { .model = "pca9535",
  85. .trigger = GPIO_INTR_NEGEDGE,
  86. .set_direction = pca9535_set_direction,
  87. .read = pca9535_read,
  88. .write = pca9535_write, },
  89. { .model = "pca85xx",
  90. .trigger = GPIO_INTR_NEGEDGE,
  91. .set_direction = pca85xx_set_direction,
  92. .read = pca85xx_read,
  93. .write = pca85xx_write, },
  94. { .model = "mcp23017",
  95. .trigger = GPIO_INTR_NEGEDGE,
  96. .init = mcp23017_init,
  97. .set_direction = mcp23017_set_direction,
  98. .set_pull_mode = mcp23017_set_pull_mode,
  99. .read = mcp23017_read,
  100. .write = mcp23017_write, },
  101. { .model = "mcp23s17",
  102. .trigger = GPIO_INTR_NEGEDGE,
  103. .init = mcp23s17_init,
  104. .set_direction = mcp23s17_set_direction,
  105. .set_pull_mode = mcp23s17_set_pull_mode,
  106. .read = mcp23s17_read,
  107. .write = mcp23s17_write, },
  108. };
  109. static EXT_RAM_ATTR uint8_t n_expanders;
  110. static EXT_RAM_ATTR QueueHandle_t message_queue;
  111. static EXT_RAM_ATTR gpio_exp_t expanders[4];
  112. static EXT_RAM_ATTR TaskHandle_t service_task;
  113. /******************************************************************************
  114. * Retrieve base from an expander reference
  115. */
  116. uint32_t gpio_exp_get_base(gpio_exp_t *expander) {
  117. return expander->first;
  118. }
  119. /******************************************************************************
  120. * Retrieve reference from a GPIO
  121. */
  122. gpio_exp_t *gpio_exp_get_expander(int gpio) {
  123. int _gpio = gpio;
  124. return find_expander(NULL, &_gpio);
  125. }
  126. /******************************************************************************
  127. * Create an I2C expander
  128. */
  129. gpio_exp_t* gpio_exp_create(const gpio_exp_config_t *config) {
  130. gpio_exp_t *expander = expanders + n_expanders;
  131. if (config->base < GPIO_NUM_MAX || n_expanders == sizeof(expanders)/sizeof(gpio_exp_t)) {
  132. ESP_LOGE(TAG, "Base %d GPIO must be at least %d for %s or too many expanders %d", config->base, GPIO_NUM_MAX, config->model, n_expanders);
  133. return NULL;
  134. }
  135. // See if we know that model (expanders is zero-initialized)
  136. for (int i = 0; !expander->model && i < sizeof(registered)/sizeof(struct gpio_exp_model_s); i++) {
  137. if (strcasestr(config->model, registered[i].model)) expander->model = registered + i;
  138. }
  139. // well... try again
  140. if (!expander->model) {
  141. ESP_LOGE(TAG,"Unknown GPIO expansion chip %s", config->model);
  142. return NULL;
  143. }
  144. n_expanders++;
  145. expander->first = config->base;
  146. expander->last = config->base + config->count - 1;
  147. expander->mutex = xSemaphoreCreateMutex();
  148. memcpy(&expander->phy, &config->phy, sizeof(struct gpio_exp_phy_s));
  149. if (expander->model->init) expander->model->init(expander);
  150. // create a task to handle asynchronous requests (only write at this time)
  151. if (!message_queue) {
  152. // we allocate TCB but stack is static to avoid SPIRAM fragmentation
  153. StaticTask_t* xTaskBuffer = (StaticTask_t*) heap_caps_malloc(sizeof(StaticTask_t), MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT);
  154. static EXT_RAM_ATTR StackType_t xStack[4*1024] __attribute__ ((aligned (4)));
  155. message_queue = xQueueCreate(4, sizeof(queue_request_t));
  156. service_task = xTaskCreateStatic(service_handler, "gpio_expander", sizeof(xStack), NULL, ESP_TASK_PRIO_MIN + 1, xStack, xTaskBuffer);
  157. }
  158. // set interrupt if possible
  159. if (config->intr > 0) {
  160. gpio_pad_select_gpio(config->intr);
  161. gpio_set_direction(config->intr, GPIO_MODE_INPUT);
  162. switch (expander->model->trigger) {
  163. case GPIO_INTR_NEGEDGE:
  164. case GPIO_INTR_LOW_LEVEL:
  165. gpio_set_pull_mode(config->intr, GPIO_PULLUP_ONLY);
  166. break;
  167. case GPIO_INTR_POSEDGE:
  168. case GPIO_INTR_HIGH_LEVEL:
  169. gpio_set_pull_mode(config->intr, GPIO_PULLDOWN_ONLY);
  170. break;
  171. default:
  172. gpio_set_pull_mode(config->intr, GPIO_PULLUP_PULLDOWN);
  173. break;
  174. }
  175. gpio_set_intr_type(config->intr, expander->model->trigger);
  176. gpio_isr_handler_add(config->intr, intr_isr_handler, expander);
  177. gpio_intr_enable(config->intr);
  178. }
  179. ESP_LOGI(TAG, "Create GPIO expander %s at base %u with INT %u at @%x on port %d", config->model, config->base, config->intr, config->phy.addr, config->phy.port);
  180. return expander;
  181. }
  182. /******************************************************************************
  183. * Add ISR handler for a GPIO
  184. */
  185. esp_err_t gpio_exp_isr_handler_add(int gpio, gpio_isr_t isr_handler, uint32_t debounce, void *arg, struct gpio_exp_s *expander) {
  186. if (gpio < GPIO_NUM_MAX && !expander) return gpio_isr_handler_add(gpio, isr_handler, arg);
  187. if ((expander = find_expander(expander, &gpio)) == NULL) return ESP_ERR_INVALID_ARG;
  188. expander->isr[gpio].handler = isr_handler;
  189. expander->isr[gpio].arg = arg;
  190. if (debounce) expander->isr[gpio].timer = xTimerCreate("gpioExpDebounce", pdMS_TO_TICKS(debounce),
  191. pdFALSE, expander->isr + gpio, debounce_handler );
  192. return ESP_OK;
  193. }
  194. /******************************************************************************
  195. * Remove ISR handler for a GPIO
  196. */
  197. esp_err_t gpio_exp_isr_handler_remove(int gpio, struct gpio_exp_s *expander) {
  198. if (gpio < GPIO_NUM_MAX && !expander) return gpio_isr_handler_remove(gpio);
  199. if ((expander = find_expander(expander, &gpio)) == NULL) return ESP_ERR_INVALID_ARG;
  200. if (expander->isr[gpio].timer) xTimerDelete(expander->isr[gpio].timer, portMAX_DELAY);
  201. memset(expander->isr + gpio, 0, sizeof(struct gpio_exp_isr_s));
  202. return ESP_OK;
  203. }
  204. /******************************************************************************
  205. * Set GPIO direction
  206. */
  207. esp_err_t gpio_exp_set_direction(int gpio, gpio_mode_t mode, gpio_exp_t *expander) {
  208. if (gpio < GPIO_NUM_MAX && !expander) return gpio_set_direction(gpio, mode);
  209. if ((expander = find_expander(expander, &gpio)) == NULL) return ESP_ERR_INVALID_ARG;
  210. xSemaphoreTake(expander->mutex, pdMS_TO_TICKS(portMAX_DELAY));
  211. if (mode == GPIO_MODE_INPUT) {
  212. expander->r_mask |= 1 << gpio;
  213. expander->shadow = expander->model->read(expander);
  214. expander->age = ~xTaskGetTickCount();
  215. } else {
  216. expander->w_mask |= 1 << gpio;
  217. }
  218. if (expander->r_mask & expander->w_mask) {
  219. xSemaphoreGive(expander->mutex);
  220. ESP_LOGE(TAG, "GPIO %d on expander base %u can't be r/w", gpio, expander->first);
  221. return ESP_ERR_INVALID_ARG;
  222. }
  223. // most expanders want unconfigured GPIO to be set to output
  224. if (expander->model->set_direction) expander->model->set_direction(expander);
  225. xSemaphoreGive(expander->mutex);
  226. return ESP_OK;
  227. }
  228. /******************************************************************************
  229. * Get GPIO level with cache
  230. */
  231. int gpio_exp_get_level(int gpio, int age, gpio_exp_t *expander) {
  232. if (gpio < GPIO_NUM_MAX && !expander) return gpio_get_level(gpio);
  233. if ((expander = find_expander(expander, &gpio)) == NULL) return -1;
  234. uint32_t now = xTaskGetTickCount();
  235. // return last thing we had if we can't get the mutex
  236. if (xSemaphoreTake(expander->mutex, pdMS_TO_TICKS(50)) == pdFALSE) {
  237. ESP_LOGW(TAG, "Can't get mutex for GPIO %d", expander->first + gpio);
  238. return (expander->shadow >> gpio) & 0x01;
  239. }
  240. // re-read the expander if data is too old
  241. if (age >= 0 && now - expander->age >= pdMS_TO_TICKS(age)) {
  242. uint32_t value = expander->model->read(expander);
  243. expander->pending |= (expander->shadow ^ value) & expander->r_mask;
  244. expander->shadow = value;
  245. expander->age = now;
  246. }
  247. // clear pending bit
  248. expander->pending &= ~(1 << gpio);
  249. xSemaphoreGive(expander->mutex);
  250. ESP_LOGD(TAG, "Get level for GPIO %u => read %x", expander->first + gpio, expander->shadow);
  251. return (expander->shadow >> gpio) & 0x01;
  252. }
  253. /******************************************************************************
  254. * Set GPIO level with cache
  255. */
  256. esp_err_t gpio_exp_set_level(int gpio, int level, bool direct, gpio_exp_t *expander) {
  257. if (gpio < GPIO_NUM_MAX && !expander) return gpio_set_level(gpio, level);
  258. if ((expander = find_expander(expander, &gpio)) == NULL) return ESP_ERR_INVALID_ARG;
  259. uint32_t mask = 1 << gpio;
  260. // very limited risk with lack of semaphore here
  261. if ((expander->w_mask & mask) == 0) {
  262. ESP_LOGW(TAG, "GPIO %d is not set for output", expander->first + gpio);
  263. return ESP_ERR_INVALID_ARG;
  264. }
  265. if (direct) {
  266. xSemaphoreTake(expander->mutex, pdMS_TO_TICKS(portMAX_DELAY));
  267. level = level ? mask : 0;
  268. mask &= expander->shadow;
  269. // only write if shadow not up to date
  270. if ((mask ^ level) && expander->model->write) {
  271. expander->shadow = (expander->shadow & ~(mask | level)) | level;
  272. expander->model->write(expander);
  273. }
  274. xSemaphoreGive(expander->mutex);
  275. ESP_LOGD(TAG, "Set level %x for GPIO %u => wrote %x", level, expander->first + gpio, expander->shadow);
  276. } else {
  277. queue_request_t request = { .gpio = gpio, .level = level, .type = ASYNC_WRITE, .expander = expander };
  278. if (xQueueSend(message_queue, &request, 0) == pdFALSE) return ESP_ERR_INVALID_RESPONSE;
  279. // notify service task that will write it when it can
  280. xTaskNotify(service_task, GPIO_EXP_WRITE, eSetValueWithoutOverwrite);
  281. }
  282. return ESP_OK;
  283. }
  284. /******************************************************************************
  285. * Set GPIO pullmode
  286. */
  287. esp_err_t gpio_exp_set_pull_mode(int gpio, gpio_pull_mode_t mode, gpio_exp_t *expander) {
  288. if (gpio < GPIO_NUM_MAX && !expander) return gpio_set_pull_mode(gpio, mode);
  289. if ((expander = find_expander(expander, &gpio)) != NULL && expander->model->set_pull_mode) {
  290. expander->pullup &= ~(1 << gpio);
  291. expander->pulldown &= ~(1 << gpio);
  292. if (mode == GPIO_PULLUP_ONLY || mode == GPIO_PULLUP_PULLDOWN) expander->pullup |= 1 << gpio;
  293. if (mode == GPIO_PULLDOWN_ONLY || mode == GPIO_PULLUP_PULLDOWN) expander->pulldown |= 1 << gpio;
  294. expander->model->set_pull_mode(expander);
  295. return ESP_OK;
  296. }
  297. return ESP_ERR_INVALID_ARG;
  298. }
  299. /******************************************************************************
  300. * Wrapper function
  301. */
  302. esp_err_t gpio_set_pull_mode_x(int gpio, gpio_pull_mode_t mode) {
  303. if (gpio < GPIO_NUM_MAX) return gpio_set_pull_mode(gpio, mode);
  304. return gpio_exp_set_pull_mode(gpio, mode, NULL);
  305. }
  306. esp_err_t gpio_set_direction_x(int gpio, gpio_mode_t mode) {
  307. if (gpio < GPIO_NUM_MAX) return gpio_set_direction(gpio, mode);
  308. return gpio_exp_set_direction(gpio, mode, NULL);
  309. }
  310. int gpio_get_level_x(int gpio) {
  311. if (gpio < GPIO_NUM_MAX) return gpio_get_level(gpio);
  312. return gpio_exp_get_level(gpio, 10, NULL);
  313. }
  314. esp_err_t gpio_set_level_x(int gpio, int level) {
  315. if (gpio < GPIO_NUM_MAX) return gpio_set_level(gpio, level);
  316. return gpio_exp_set_level(gpio, level, false, NULL);
  317. }
  318. esp_err_t gpio_isr_handler_add_x(int gpio, gpio_isr_t isr_handler, void* args) {
  319. if (gpio < GPIO_NUM_MAX) return gpio_isr_handler_add(gpio, isr_handler, args);
  320. return gpio_exp_isr_handler_add(gpio, isr_handler, 0, args, NULL);
  321. }
  322. esp_err_t gpio_isr_handler_remove_x(int gpio) {
  323. if (gpio < GPIO_NUM_MAX) return gpio_isr_handler_remove(gpio);
  324. return gpio_exp_isr_handler_remove(gpio, NULL);
  325. }
  326. /****************************************************************************************
  327. * INTR low-level handler
  328. */
  329. static void IRAM_ATTR intr_isr_handler(void* arg) {
  330. BaseType_t woken = pdFALSE;
  331. xTaskNotifyFromISR(service_task, GPIO_EXP_INTR, eSetValueWithOverwrite, &woken);
  332. if (woken) portYIELD_FROM_ISR();
  333. ESP_EARLY_LOGD(TAG, "INTR for expander base %d", gpio_exp_get_base(arg));
  334. }
  335. /****************************************************************************************
  336. * INTR debounce handler
  337. */
  338. static void debounce_handler( TimerHandle_t xTimer ) {
  339. struct gpio_exp_isr_s *isr = (struct gpio_exp_isr_s*) pvTimerGetTimerID (xTimer);
  340. isr->handler(isr->arg);
  341. }
  342. /****************************************************************************************
  343. * Service task
  344. */
  345. void service_handler(void *arg) {
  346. while (1) {
  347. queue_request_t request;
  348. uint32_t notif = ulTaskNotifyTake(pdTRUE, portMAX_DELAY);
  349. // we have been notified of an interrupt
  350. if (notif == GPIO_EXP_INTR) {
  351. /* If we want a smarter bitmap of expanders with a pending interrupt
  352. we'll have to disable interrupts while clearing that bitmap. For
  353. now, a loop will do */
  354. for (int i = 0; i < n_expanders; i++) {
  355. gpio_exp_t *expander = expanders + i;
  356. xSemaphoreTake(expander->mutex, pdMS_TO_TICKS(50));
  357. // read GPIOs and clear all pending status
  358. uint32_t value = expander->model->read(expander);
  359. uint32_t pending = expander->pending | ((expander->shadow ^ value) & expander->r_mask);
  360. expander->shadow = value;
  361. expander->pending = 0;
  362. expander->age = xTaskGetTickCount();
  363. xSemaphoreGive(expander->mutex);
  364. ESP_LOGD(TAG, "Handling GPIO %d reads 0x%04x and has 0x%04x pending", expander->first, expander->shadow, pending);
  365. for (int gpio = 31, clz; pending; pending <<= (clz + 1)) {
  366. clz = __builtin_clz(pending);
  367. gpio -= clz;
  368. if (expander->isr[gpio].timer) xTimerReset(expander->isr[gpio].timer, 1); // todo 0
  369. else if (expander->isr[gpio].handler) expander->isr[gpio].handler(expander->isr[gpio].arg);
  370. }
  371. }
  372. }
  373. // check if we have some other pending requests
  374. if (xQueueReceive(message_queue, &request, 0) == pdTRUE) {
  375. esp_err_t err = gpio_exp_set_level(request.gpio, request.level, true, request.expander);
  376. if (err != ESP_OK) ESP_LOGW(TAG, "Can't execute async GPIO %d write request (%d)", request.gpio, err);
  377. }
  378. }
  379. }
  380. /****************************************************************************************
  381. * Find the expander related to base
  382. */
  383. static gpio_exp_t* find_expander(gpio_exp_t *expander, int *gpio) {
  384. // a mutex would be better, but risk is so small...
  385. for (int i = 0; !expander && i < n_expanders; i++) {
  386. if (*gpio >= expanders[i].first && *gpio <= expanders[i].last) expander = expanders + i;
  387. }
  388. // normalize GPIO number
  389. if (expander && *gpio >= expander->first) *gpio -= expander->first;
  390. return expander;
  391. }
  392. /****************************************************************************************
  393. DRIVERS
  394. ****************************************************************************************/
  395. /****************************************************************************************
  396. * PCA9535 family : direction, read and write
  397. */
  398. static void pca9535_set_direction(gpio_exp_t* self) {
  399. i2c_write(self->phy.port, self->phy.addr, 0x06, self->r_mask, 2);
  400. }
  401. static int pca9535_read(gpio_exp_t* self) {
  402. return i2c_read(self->phy.port, self->phy.addr, 0x00, 2);
  403. }
  404. static void pca9535_write(gpio_exp_t* self) {
  405. i2c_write(self->phy.port, self->phy.addr, 0x02, self->shadow, 2);
  406. }
  407. /****************************************************************************************
  408. * PCA85xx family : read and write
  409. */
  410. static void pca85xx_set_direction(gpio_exp_t* self) {
  411. // all inputs must be set to 1 (open drain) and output are left open as well
  412. i2c_write(self->phy.port, self->phy.addr, 0xff, self->r_mask | self->w_mask, true);
  413. }
  414. static int pca85xx_read(gpio_exp_t* self) {
  415. return i2c_read(self->phy.port, self->phy.addr, 0xff, 2);
  416. }
  417. static void pca85xx_write(gpio_exp_t* self) {
  418. // all input must be set to 1 (open drain)
  419. i2c_write(self->phy.port, self->phy.addr, 0xff, self->shadow | self->r_mask, true);
  420. }
  421. /****************************************************************************************
  422. * MCP23017 family : init, direction, read and write
  423. */
  424. static esp_err_t mcp23017_init(gpio_exp_t* self) {
  425. /*
  426. 0111 x10x = same bank, mirrot single int, no sequentµial, open drain, active low
  427. not sure about this funny change of mapping of the control register itself, really?
  428. */
  429. esp_err_t err = i2c_write(self->phy.port, self->phy.addr, 0x05, 0x74, 1);
  430. err |= i2c_write(self->phy.port, self->phy.addr, 0x0a, 0x74, 1);
  431. // no interrupt on comparison or on change
  432. err |= i2c_write(self->phy.port, self->phy.addr, 0x04, 0x00, 2);
  433. err |= i2c_write(self->phy.port, self->phy.addr, 0x08, 0x00, 2);
  434. return err;
  435. }
  436. static void mcp23017_set_direction(gpio_exp_t* self) {
  437. // default to input and set real input to generate interrupt
  438. i2c_write(self->phy.port, self->phy.addr, 0x00, ~self->w_mask, 2);
  439. i2c_write(self->phy.port, self->phy.addr, 0x04, self->r_mask, 2);
  440. }
  441. static void mcp23017_set_pull_mode(gpio_exp_t* self) {
  442. i2c_write(self->phy.port, self->phy.addr, 0x0c, self->pullup, 2);
  443. }
  444. static int mcp23017_read(gpio_exp_t* self) {
  445. // read the pins value, not the stored one @interrupt
  446. return i2c_read(self->phy.port, self->phy.addr, 0x12, 2);
  447. }
  448. static void mcp23017_write(gpio_exp_t* self) {
  449. i2c_write(self->phy.port, self->phy.addr, 0x12, self->shadow, 2);
  450. }
  451. /****************************************************************************************
  452. * MCP23s17 family : init, direction, read and write
  453. */
  454. static esp_err_t mcp23s17_init(gpio_exp_t* self) {
  455. self->spi_handle = spi_config(&self->phy);
  456. /*
  457. 0111 x10x = same bank, mirrot single int, no sequentµial, open drain, active low
  458. not sure about this funny change of mapping of the control register itself, really?
  459. */
  460. esp_err_t err = spi_write(self->spi_handle, self->phy.addr, 0x05, 0x74, 1);
  461. err |= spi_write(self->spi_handle, self->phy.addr, 0x0a, 0x74, 1);
  462. // no interrupt on comparison or on change
  463. err |= spi_write(self->spi_handle, self->phy.addr, 0x04, 0x00, 2);
  464. err |= spi_write(self->spi_handle, self->phy.addr, 0x08, 0x00, 2);
  465. return err;
  466. }
  467. static void mcp23s17_set_direction(gpio_exp_t* self) {
  468. // default to input and set real input to generate interrupt
  469. spi_write(self->spi_handle, self->phy.addr, 0x00, ~self->w_mask, 2);
  470. spi_write(self->spi_handle, self->phy.addr, 0x04, self->r_mask, 2);
  471. }
  472. static void mcp23s17_set_pull_mode(gpio_exp_t* self) {
  473. spi_write(self->spi_handle, self->phy.addr, 0x0c, self->pullup, 2);
  474. }
  475. static int mcp23s17_read(gpio_exp_t* self) {
  476. // read the pins value, not the stored one @interrupt
  477. return spi_read(self->spi_handle, self->phy.addr, 0x12, 2);
  478. }
  479. static void mcp23s17_write(gpio_exp_t* self) {
  480. spi_write(self->spi_handle, self->phy.addr, 0x12, self->shadow, 2);
  481. }
  482. /***************************************************************************************
  483. I2C low level
  484. ***************************************************************************************/
  485. /****************************************************************************************
  486. * I2C write up to 32 bits
  487. */
  488. static esp_err_t i2c_write(uint8_t port, uint8_t addr, uint8_t reg, uint32_t data, int len) {
  489. i2c_cmd_handle_t cmd = i2c_cmd_link_create();
  490. i2c_master_start(cmd);
  491. i2c_master_write_byte(cmd, (addr << 1) | I2C_MASTER_WRITE, I2C_MASTER_NACK);
  492. if (reg != 0xff) i2c_master_write_byte(cmd, reg, I2C_MASTER_NACK);
  493. // works with out endianness
  494. if (len > 1) i2c_master_write(cmd, (uint8_t*) &data, len, I2C_MASTER_NACK);
  495. else i2c_master_write_byte(cmd, data, I2C_MASTER_NACK);
  496. i2c_master_stop(cmd);
  497. esp_err_t ret = i2c_master_cmd_begin(port, cmd, 100 / portTICK_RATE_MS);
  498. i2c_cmd_link_delete(cmd);
  499. if (ret != ESP_OK) {
  500. ESP_LOGW(TAG, "I2C write failed");
  501. }
  502. return ret;
  503. }
  504. /****************************************************************************************
  505. * I2C read up to 32 bits
  506. */
  507. static uint32_t i2c_read(uint8_t port, uint8_t addr, uint8_t reg, int len) {
  508. uint32_t data = 0;
  509. i2c_cmd_handle_t cmd = i2c_cmd_link_create();
  510. i2c_master_start(cmd);
  511. i2c_master_write_byte(cmd, (addr << 1) | I2C_MASTER_WRITE, I2C_MASTER_NACK);
  512. // when using a register, write it's value then the device address again
  513. if (reg != 0xff) {
  514. i2c_master_write_byte(cmd, reg, I2C_MASTER_NACK);
  515. i2c_master_start(cmd);
  516. i2c_master_write_byte(cmd, (addr << 1) | I2C_MASTER_READ, I2C_MASTER_NACK);
  517. }
  518. // works with out endianness
  519. if (len > 1) i2c_master_read(cmd, (uint8_t*) &data, len, I2C_MASTER_LAST_NACK);
  520. else i2c_master_read_byte(cmd, (uint8_t*) &data, I2C_MASTER_NACK);
  521. i2c_master_stop(cmd);
  522. esp_err_t ret = i2c_master_cmd_begin(port, cmd, 100 / portTICK_RATE_MS);
  523. i2c_cmd_link_delete(cmd);
  524. if (ret != ESP_OK) {
  525. ESP_LOGW(TAG, "I2C read failed");
  526. }
  527. return data;
  528. }
  529. /***************************************************************************************
  530. SPI low level
  531. ***************************************************************************************/
  532. /****************************************************************************************
  533. * SPI device addition
  534. */
  535. static spi_device_handle_t spi_config(struct gpio_exp_phy_s *phy) {
  536. spi_device_interface_config_t config;
  537. spi_device_handle_t handle = NULL;
  538. // initialize ChipSelect (CS)
  539. gpio_set_direction(phy->cs_pin, GPIO_MODE_OUTPUT );
  540. gpio_set_level(phy->cs_pin, 0 );
  541. memset( &config, 0, sizeof( spi_device_interface_config_t ) );
  542. config.command_bits = config.address_bits = 8;
  543. config.clock_speed_hz = phy->speed ? phy->speed : SPI_MASTER_FREQ_8M;
  544. config.spics_io_num = phy->cs_pin;
  545. config.queue_size = 1;
  546. config.flags = SPI_DEVICE_NO_DUMMY;
  547. spi_bus_add_device( phy->host, &config, &handle );
  548. return handle;
  549. }
  550. /****************************************************************************************
  551. * SPI write up to 32 bits
  552. */
  553. static esp_err_t spi_write(spi_device_handle_t handle, uint8_t addr, uint8_t reg, uint32_t data, int len) {
  554. spi_transaction_t transaction = { };
  555. // rx_buffer is NULL, nothing to receive
  556. transaction.flags = SPI_TRANS_USE_TXDATA;
  557. transaction.cmd = addr << 1;
  558. transaction.addr = reg;
  559. transaction.tx_data[1] = data; transaction.tx_data[2] = data >> 8;
  560. transaction.length = len * 8;
  561. // only do polling as we don't have contention on SPI (otherwise DMA for transfers > 16 bytes)
  562. return spi_device_polling_transmit(handle, &transaction);
  563. }
  564. /****************************************************************************************
  565. * SPI read up to 32 bits
  566. */
  567. static uint32_t spi_read(spi_device_handle_t handle, uint8_t addr, uint8_t reg, int len) {
  568. spi_transaction_t transaction = { };
  569. // tx_buffer is NULL, nothing to transmit except cmd/addr
  570. transaction.flags = SPI_TRANS_USE_RXDATA;
  571. transaction.cmd = (addr << 1) | 1;
  572. transaction.addr = reg;
  573. transaction.length = len * 8;
  574. // only do polling as we don't have contention on SPI (otherwise DMA for transfers > 16 bytes)
  575. spi_device_polling_transmit(handle, &transaction);
  576. return *(uint32_t*) transaction.rx_data;
  577. }