lws-bb-spi.h

Go to the documentation of this file.

/*
 * I2C - bitbanged generic gpio implementation
 *
 * Copyright (C) 2019 - 2020 Andy Green <andy@warmcat.com>
 *
 * 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.
 *
 * This is like an abstract class for gpio, a real implementation provides
 * functions for the ops that use the underlying OS gpio arrangements.
 */
 
#define LWSBBSPI_FLAG_USE_NCMD3         (1 << 7)
#define LWSBBSPI_FLAG_USE_NCMD2         (1 << 6)
#define LWSBBSPI_FLAG_USE_NCMD1         (1 << 5)
#define LWSBBSPI_FLAG_USE_NCMD0         (1 << 4)
#define LWSBBSPI_FLAG_USE_NCS3          (1 << 3)
#define LWSBBSPI_FLAG_USE_NCS2          (1 << 2)
#define LWSBBSPI_FLAG_USE_NCS1          (1 << 1)
#define LWSBBSPI_FLAG_USE_NCS0          (1 << 0)
 
#define LWS_SPI_BB_MAX_CH               4
 
typedef struct lws_bb_spi {
        lws_spi_ops_t           bb_ops; /* init to lws_bb_spi_ops */
 
        /* implementation-specific members */
        const lws_gpio_ops_t    *gpio;
 
        _lws_plat_gpio_t        clk;
        _lws_plat_gpio_t        ncs[LWS_SPI_BB_MAX_CH];
        _lws_plat_gpio_t        ncmd[LWS_SPI_BB_MAX_CH];
        _lws_plat_gpio_t        mosi;
        _lws_plat_gpio_t        miso;
 
        uint8_t                 unit;
 
        uint8_t                 flags;
} lws_bb_spi_t;
 
#define lws_bb_spi_ops \
                .init           = lws_bb_spi_init, \
                .queue          = lws_bb_spi_queue
 
int
lws_bb_spi_init(const lws_spi_ops_t *octx);
 
int
lws_bb_spi_queue(const lws_spi_ops_t *octx, const lws_spi_desc_t *desc);