libwebsockets
Lightweight C library for HTML5 websockets
lws-bb-spi.h
1 /*
2  * I2C - bitbanged generic gpio 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 #define LWSBBSPI_FLAG_USE_NCMD3 (1 << 7)
29 #define LWSBBSPI_FLAG_USE_NCMD2 (1 << 6)
30 #define LWSBBSPI_FLAG_USE_NCMD1 (1 << 5)
31 #define LWSBBSPI_FLAG_USE_NCMD0 (1 << 4)
32 #define LWSBBSPI_FLAG_USE_NCS3 (1 << 3)
33 #define LWSBBSPI_FLAG_USE_NCS2 (1 << 2)
34 #define LWSBBSPI_FLAG_USE_NCS1 (1 << 1)
35 #define LWSBBSPI_FLAG_USE_NCS0 (1 << 0)
36 
37 #define LWS_SPI_BB_MAX_CH 4
38 
39 typedef struct lws_bb_spi {
40  lws_spi_ops_t bb_ops; /* init to lws_bb_spi_ops */
41 
42  /* implementation-specific members */
43  const lws_gpio_ops_t *gpio;
44 
45  _lws_plat_gpio_t clk;
46  _lws_plat_gpio_t ncs[LWS_SPI_BB_MAX_CH];
47  _lws_plat_gpio_t ncmd[LWS_SPI_BB_MAX_CH];
48  _lws_plat_gpio_t mosi;
49  _lws_plat_gpio_t miso;
50 
51  uint8_t flags;
52 } lws_bb_spi_t;
53 
54 #define lws_bb_spi_ops \
55  .init = lws_bb_spi_init, \
56  .queue = lws_bb_spi_queue
57 
58 int
59 lws_bb_spi_init(const lws_spi_ops_t *octx);
60 
61 int
62 lws_bb_spi_queue(const lws_spi_ops_t *octx, const lws_spi_desc_t *desc);
Definition: lws-bb-spi.h:39
Definition: lws-gpio.h:52
Definition: lws-spi.h:54
Definition: lws-spi.h:67