forked from UncleRus/esp-idf-lib
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathled_strip_spi_esp32.h
116 lines (106 loc) · 4.67 KB
/
led_strip_spi_esp32.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
/*
* MIT License
*
* Copyright (c) 2021 Tomoyuki Sakurai <[email protected]>
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
/**
* @file led_strip_spi_esp8266.h
* @defgroup led_strip_spi_esp32 led_strip_spi_esp32
* @{
*/
#if !defined(__LED_STRIP_SPI_ESP32__H__)
#define __LED_STRIP_SPI_ESP32__H__
#include <esp_idf_lib_helpers.h>
#include <esp_idf_version.h>
#include <driver/spi_master.h>
#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(4, 0, 0)
#define LED_STRIP_SPI_DEFAULT_HOST_DEVICE HSPI_HOST
#else
#define LED_STRIP_SPI_DEFAULT_HOST_DEVICE SPI2_HOST ///< Default is `SPI2_HOST` (`HSPI_HOST` if `esp-idf` version is v3.x).
#endif
#if defined(CONFIG_IDF_TARGET_ESP32C2) || defined(CONFIG_IDF_TARGET_ESP32C3) \
|| defined(CONFIG_IDF_TARGET_ESP32C6)
#define LED_STRIP_SPI_DEFAULT_MOSI_IO_NUM (7)
#define LED_STRIP_SPI_DEFAULT_SCLK_IO_NUM (6)
#elif defined(CONFIG_IDF_TARGET_ESP32S2) || defined(CONFIG_IDF_TARGET_ESP32S3)
#define LED_STRIP_SPI_DEFAULT_MOSI_IO_NUM (11)
#define LED_STRIP_SPI_DEFAULT_SCLK_IO_NUM (12)
#elif defined(CONFIG_IDF_TARGET_ESP32H2)
#define LED_STRIP_SPI_DEFAULT_MOSI_IO_NUM (5)
#define LED_STRIP_SPI_DEFAULT_SCLK_IO_NUM (4)
#else
#define LED_STRIP_SPI_DEFAULT_MOSI_IO_NUM (13) ///< GPIO pin number of `LED_STRIP_SPI_DEFAULT_HOST_DEVICE`'s MOSI (default is 13 for ESP32, 7 for ESP32C3)
#define LED_STRIP_SPI_DEFAULT_SCLK_IO_NUM (14) ///< GPIO pin number of `LED_STRIP_SPI_DEFAULT_HOST_DEVICE`'s SCLK (default is 14 for ESP32, 6 for ESP32C3)
#endif
/**
* LED strip descriptor for ESP32-family.
*/
typedef struct
{
void *buf; //< Pointer to the buffer
size_t length; //< Number of pixels
spi_host_device_t host_device; //< SPI host device name, such as `SPI2_HOST`.
int mosi_io_num; ///< GPIO number of SPI MOSI.
int sclk_io_num; ///< GPIO number of SPI SCLK.
int max_transfer_sz; ///< Maximum transfer size in bytes. Defaults to 4094 if 0.
int clock_speed_hz; ///< Clock speed in Hz.
int queue_size; ///< Queue size used by `spi_device_queue_trans()`.
spi_device_handle_t device_handle; ///< Device handle assigned by the driver. The caller must provdie this.
int dma_chan; ///< DMA channed to use. Either 1 or 2.
spi_transaction_t transaction; ///< SPI transaction used internally by the driver.
} led_strip_spi_esp32_t;
/**
* Default DMA channel to use. Default is `SPI_DMA_CH_AUTO` for ESP-IDF v4.3
* and newer, 1 for older versions.
*/
#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(4, 3, 0)
#define LED_STRIP_SPI_DEFAULT_DMA_CHAN (1)
#else
#define LED_STRIP_SPI_DEFAULT_DMA_CHAN SPI_DMA_CH_AUTO
#endif
/**
* Macro to initialize ::led_strip_spi_esp32_t
*
* `buf`: `NULL`,
* `length`: 1,
* `host_device`: `LED_STRIP_SPI_DEFAULT_HOST_DEVICE`,
* `mosi_io_num`: `LED_STRIP_SPI_DEFAULT_MOSI_IO_NUM`,
* `max_transfer_sz`: 0,
* `clock_speed_hz`: 1000000,
* `queue_size`: 1,
* `device_handle`: `NULL`,
* `dma_chan`: 1
*/
#define LED_STRIP_SPI_DEFAULT_ESP32() \
{ \
.buf = NULL, \
.length = 1, \
.host_device = LED_STRIP_SPI_DEFAULT_HOST_DEVICE, \
.mosi_io_num = LED_STRIP_SPI_DEFAULT_MOSI_IO_NUM, \
.sclk_io_num = LED_STRIP_SPI_DEFAULT_SCLK_IO_NUM, \
.max_transfer_sz = 0, \
.clock_speed_hz = 1000000, \
.queue_size = 1, \
.device_handle = NULL, \
.dma_chan = LED_STRIP_SPI_DEFAULT_DMA_CHAN, \
}
/** @} */
#endif // __LED_STRIP_SPI_ESP32__H__