libwebsockets
Lightweight C library for HTML5 websockets
lws-esp32-spi.h
Go to the documentation of this file.
1 /*
2  * SPI - esp32 esp-idf api implementation
3  *
4  * Copyright (C) 2019 - 2020 Andy Green <andy@warmcat.com>
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to
8  * deal in the Software without restriction, including without limitation the
9  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
10  * sell copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
22  * IN THE SOFTWARE.
23  *
24  * This is like an abstract class for gpio, a real implementation provides
25  * functions for the ops that use the underlying OS gpio arrangements.
26  */
27 
28 #if defined(ESP_PLATFORM)
29 
30 #define lws_esp32_spi_ops
31  .init = lws_esp32_spi_init,
32  .queue = lws_esp32_spi_queue,
33  .alloc_dma = lws_esp32_spi_alloc_dma,
34  .free_dma = lws_esp32_spi_free_dma,
35  .in_flight = lws_esp32_spi_in_flight
36 
37 LWS_VISIBLE LWS_EXTERN int
38 lws_esp32_spi_init(const lws_spi_ops_t *spi_ops);
39 
40 LWS_VISIBLE LWS_EXTERN int
41 lws_esp32_spi_queue(const lws_spi_ops_t *spi_ops, const lws_spi_desc_t *desc);
42 
43 LWS_VISIBLE LWS_EXTERN void *
44 lws_esp32_spi_alloc_dma(const struct lws_spi_ops *ctx, size_t size);
45 
46 LWS_VISIBLE LWS_EXTERN void
47 lws_esp32_spi_free_dma(const struct lws_spi_ops *ctx, void **p);
48 
49 LWS_VISIBLE LWS_EXTERN int
50 lws_esp32_spi_in_flight(const struct lws_spi_ops *ctx);
51 
52 #endif