spi_engine_private.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   spi_engine_private.h
 *   @brief  Private definitions of the SPI Engine
 *   @author Sergiu Cuciurean (sergiu.cuciurean@analog.com)
********************************************************************************
 * Copyright 2019(c) Analog Devices, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Analog Devices, Inc. nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/
 
#ifndef SPI_ENGINE_PRIVATE_H
#define SPI_ENGINE_PRIVATE_H
 
#include <stdint.h>
#include <stdbool.h>
 
#include "no_os_spi.h"
#include "no_os_util.h"
 
#define SPI_ENGINE_REG_VERSION          0x00
#define SPI_ENGINE_REG_DATA_WIDTH       0x0C
#define SPI_ENGINE_REG_RESET            0x40
#define SPI_ENGINE_REG_INT_ENABLE       0x80
#define SPI_ENGINE_REG_INT_PENDING      0x84
#define SPI_ENGINE_REG_INT_SOURCE       0x88
#define SPI_ENGINE_REG_SYNC_ID          0xC0
#define SPI_ENGINE_REG_CMD_FIFO_ROOM        0xD0
#define SPI_ENGINE_REG_SDO_FIFO_ROOM        0xD4
#define SPI_ENGINE_REG_SDI_FIFO_LEVEL       0xD8
#define SPI_ENGINE_REG_CMD_FIFO         0xE0
#define SPI_ENGINE_REG_SDO_DATA_FIFO        0xE4
#define SPI_ENGINE_REG_SDI_DATA_FIFO        0xE8
#define SPI_ENGINE_REG_SDI_DATA_FIFO_PEEK   0xEC
 
/* Bit definitions for SPI_ENGINE_REG_DATA_WIDTH register */
#define SPI_ENGINE_REG_NUM_OF_SDI_MSK       NO_OS_GENMASK(23, 16)
#define SPI_ENGINE_REG_DATA_WIDTH_MSK       NO_OS_GENMASK(15, 0)
 
#define SPI_ENGINE_INST_TRANSFER        0x00
#define SPI_ENGINE_INST_ASSERT          0x01
#define SPI_ENGINE_INST_CONFIG          0x02
#define SPI_ENGINE_INST_SYNC_SLEEP      0x03
#define SPI_ENGINE_INST_MISC            0x03
#define SPI_ENGINE_CMD_REG_CLK_DIV      0x00
#define SPI_ENGINE_CMD_REG_CONFIG       0x01
#define SPI_ENGINE_CMD_DATA_TRANSFER_LEN    0x02
#define SPI_ENGINE_MISC_SYNC            0x00
#define SPI_ENGINE_MISC_SLEEP           0x01
#define SPI_ENGINE_SYNC_TRANSFER_BEGIN      NO_OS_BIT(1)
#define SPI_ENGINE_SYNC_TRANSFER_END        NO_OS_BIT(2)
#define SPI_ENGINE_INT_CMD_ALMOST_EMPTY     NO_OS_BIT(0)
#define SPI_ENGINE_INT_SDO_ALMOST_EMPTY     NO_OS_BIT(1)
#define SPI_ENGINE_INT_SDI_ALMOST_FULL      NO_OS_BIT(2)
#define SPI_ENGINE_INT_SYNC         NO_OS_BIT(3)
#define SPI_ENGINE_OFFLOAD_CTRL_ENABLE      NO_OS_BIT(0)
#define SPI_ENGINE_OFFLOAD_STATUS_ENABLED   NO_OS_BIT(0)
#define SPI_ENGINE_CONFIG_CPHA          NO_OS_BIT(0)
#define SPI_ENGINE_CONFIG_CPOL          NO_OS_BIT(1)
#define SPI_ENGINE_CONFIG_3WIRE         NO_OS_BIT(2)
#define SPI_ENGINE_CONFIG_SDO_IDLE      NO_OS_BIT(3)
#define SPI_ENGINE_VERSION_MAJOR(x)         ((x >> 16) & 0xff)
#define SPI_ENGINE_VERSION_MINOR(x)         ((x >> 8) & 0xff)
#define SPI_ENGINE_VERSION_PATCH(x)         (x & 0xff)
 
#define SPI_ENGINE_INSTRUCTION_TRANSFER_W   0x01
#define SPI_ENGINE_INSTRUCTION_TRANSFER_R   0x02
#define SPI_ENGINE_INSTRUCTION_TRANSFER_RW  0x03
 
#define SPI_ENGINE_REG_OFFLOAD_CTRL(x)      (0x100 + (0x20 * x))
#define SPI_ENGINE_REG_OFFLOAD_STATUS(x)    (0x104 + (0x20 * x))
#define SPI_ENGINE_REG_OFFLOAD_RESET(x)     (0x108 + (0x20 * x))
#define SPI_ENGINE_REG_OFFLOAD_CMD_MEM(x)   (0x110 + (0x20 * x))
#define SPI_ENGINE_REG_OFFLOAD_SDO_MEM(x)   (0x114 + (0x20 * x))
 
#define SPI_ENGINE_CMD(inst, arg1, arg2)                \
            (((inst & 0x03) << 12) |            \
            ((arg1 & 0x03) << 8) | arg2 )
#define SPI_ENGINE_CMD(inst, arg1, arg2)                \ …
 
#define SPI_ENGINE_CMD_TRANSFER(readwrite, n)               \
    SPI_ENGINE_CMD(SPI_ENGINE_INST_TRANSFER,            \
            (readwrite), (n))
#define SPI_ENGINE_CMD_TRANSFER(readwrite, n)               \ …
 
#define SPI_ENGINE_CMD_ASSERT(delay, cs)                \
    SPI_ENGINE_CMD(SPI_ENGINE_INST_ASSERT,              \
            (delay), (cs))
#define SPI_ENGINE_CMD_ASSERT(delay, cs)                \ …
 
#define SPI_ENGINE_CMD_CONFIG(reg, val)                 \
    SPI_ENGINE_CMD(SPI_ENGINE_INST_CONFIG,              \
            (reg), (val))
#define SPI_ENGINE_CMD_CONFIG(reg, val)                 \ …
 
#define SPI_ENGINE_CMD_SLEEP(delay)                     \
    SPI_ENGINE_CMD(SPI_ENGINE_INST_MISC,                \
            SPI_ENGINE_MISC_SLEEP,              \
            (delay))
#define SPI_ENGINE_CMD_SLEEP(delay)                     \ …
 
#define SPI_ENGINE_CMD_SYNC(id)                     \
    SPI_ENGINE_CMD(SPI_ENGINE_INST_MISC,                \
            SPI_ENGINE_MISC_SYNC,               \
            (id))
#define SPI_ENGINE_CMD_SYNC(id)                     \ …
 
typedef struct spi_engine_cmd_queue {
    uint32_t    cmd;
    struct      spi_engine_cmd_queue *next;
} spi_engine_cmd_queue;
typedef struct spi_engine_cmd_queue {…};
 
typedef struct spi_engine_msg {
    uint32_t            *tx_buf;
    uint32_t            *rx_buf;
    uint32_t            length;
    struct spi_engine_cmd_queue *cmds;
} spi_engine_msg;
typedef struct spi_engine_msg {…};
 
#endif // SPI_ENGINE_PRIVATE_H