fsl_lpspi_edma.h

/*
 * Copyright (c) 2015, Freescale Semiconductor, Inc.
 * Copyright 2016-2022 NXP
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */
#ifndef _FSL_LPSPI_EDMA_H_
#define _FSL_LPSPI_EDMA_H_
 
#include "fsl_lpspi.h"
#include "fsl_edma.h"
 
/*
 * @addtogroup lpspi_edma_driver
 * @{
 */
 
/***********************************************************************************************************************
 * Definitions
 **********************************************************************************************************************/
#define FSL_LPSPI_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 4, 0))
typedef struct _lpspi_master_edma_handle lpspi_master_edma_handle_t;
 
typedef struct _lpspi_slave_edma_handle lpspi_slave_edma_handle_t;
 
typedef void (*lpspi_master_edma_transfer_callback_t)(LPSPI_Type *base,
                                                      lpspi_master_edma_handle_t *handle,
                                                      status_t status,
                                                      void *userData);
typedef void (*lpspi_slave_edma_transfer_callback_t)(LPSPI_Type *base,
                                                     lpspi_slave_edma_handle_t *handle,
                                                     status_t status,
                                                     void *userData);
 
struct _lpspi_master_edma_handle
{
    volatile bool isPcsContinuous; 
    volatile bool isByteSwap; 
    volatile uint8_t fifoSize; 
    volatile uint8_t rxWatermark; 
    volatile uint8_t bytesEachWrite; 
    volatile uint8_t bytesEachRead;  
    volatile uint8_t bytesLastRead;    
    volatile bool isThereExtraRxBytes; 
    uint8_t *volatile txData;             
    uint8_t *volatile rxData;             
    volatile size_t txRemainingByteCount; 
    volatile size_t rxRemainingByteCount; 
    volatile uint32_t writeRegRemainingTimes; 
    volatile uint32_t readRegRemainingTimes;  
    uint32_t totalByteCount; 
    uint32_t txBuffIfNull; 
    uint32_t rxBuffIfNull; 
    uint32_t transmitCommand; 
    volatile uint8_t state; 
    uint8_t nbytes; 
    lpspi_master_edma_transfer_callback_t callback; 
    void *userData;                                 
    edma_handle_t *edmaRxRegToRxDataHandle; 
    edma_handle_t *edmaTxDataToTxRegHandle; 
    edma_tcd_t lpspiSoftwareTCD[3]; 
};
 
struct _lpspi_slave_edma_handle
{
    volatile bool isByteSwap; 
    volatile uint8_t fifoSize; 
    volatile uint8_t rxWatermark; 
    volatile uint8_t bytesEachWrite; 
    volatile uint8_t bytesEachRead;  
    volatile uint8_t bytesLastRead;    
    volatile bool isThereExtraRxBytes; 
    uint8_t nbytes; 
    uint8_t *volatile txData;             
    uint8_t *volatile rxData;             
    volatile size_t txRemainingByteCount; 
    volatile size_t rxRemainingByteCount; 
    volatile uint32_t writeRegRemainingTimes; 
    volatile uint32_t readRegRemainingTimes;  
    uint32_t totalByteCount; 
    uint32_t txBuffIfNull; 
    uint32_t rxBuffIfNull; 
    volatile uint8_t state; 
    uint32_t errorCount; 
    lpspi_slave_edma_transfer_callback_t callback; 
    void *userData;                                
    edma_handle_t *edmaRxRegToRxDataHandle; 
    edma_handle_t *edmaTxDataToTxRegHandle; 
    edma_tcd_t lpspiSoftwareTCD[2]; 
};
 
/***********************************************************************************************************************
 * API
 **********************************************************************************************************************/
#if defined(__cplusplus)
extern "C" {
#endif /*_cplusplus*/
 
/*Transactional APIs*/
 
void LPSPI_MasterTransferCreateHandleEDMA(LPSPI_Type *base,
                                          lpspi_master_edma_handle_t *handle,
                                          lpspi_master_edma_transfer_callback_t callback,
                                          void *userData,
                                          edma_handle_t *edmaRxRegToRxDataHandle,
                                          edma_handle_t *edmaTxDataToTxRegHandle);
 
status_t LPSPI_MasterTransferEDMA(LPSPI_Type *base, lpspi_master_edma_handle_t *handle, lpspi_transfer_t *transfer);
 
status_t LPSPI_MasterTransferPrepareEDMALite(LPSPI_Type *base, lpspi_master_edma_handle_t *handle, uint32_t configFlags);
 
status_t LPSPI_MasterTransferEDMALite(LPSPI_Type *base, lpspi_master_edma_handle_t *handle, lpspi_transfer_t *transfer);
 
void LPSPI_MasterTransferAbortEDMA(LPSPI_Type *base, lpspi_master_edma_handle_t *handle);
 
status_t LPSPI_MasterTransferGetCountEDMA(LPSPI_Type *base, lpspi_master_edma_handle_t *handle, size_t *count);
 
void LPSPI_SlaveTransferCreateHandleEDMA(LPSPI_Type *base,
                                         lpspi_slave_edma_handle_t *handle,
                                         lpspi_slave_edma_transfer_callback_t callback,
                                         void *userData,
                                         edma_handle_t *edmaRxRegToRxDataHandle,
                                         edma_handle_t *edmaTxDataToTxRegHandle);
 
status_t LPSPI_SlaveTransferEDMA(LPSPI_Type *base, lpspi_slave_edma_handle_t *handle, lpspi_transfer_t *transfer);
 
void LPSPI_SlaveTransferAbortEDMA(LPSPI_Type *base, lpspi_slave_edma_handle_t *handle);
 
status_t LPSPI_SlaveTransferGetCountEDMA(LPSPI_Type *base, lpspi_slave_edma_handle_t *handle, size_t *count);
 
#if defined(__cplusplus)
}
#endif
 
/* @}*/
 
#endif /*_FSL_LPSPI_EDMA_H_*/