UDMAMSP432.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2018, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  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.
 *
 * *  Neither the name of Texas Instruments Incorporated 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT OWNER OR
 * CONTRIBUTORS 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 ti_drivers_dma_UDMAMSP432__include
#define ti_drivers_dma_UDMAMSP432__include

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stdbool.h>

#include <ti/drivers/dpl/HwiP.h>

typedef void (*UDMAMSP432_ErrorFxn)(uintptr_t arg);

typedef struct UDMAMSP432_HWAttrs {
    void           *controlBaseAddr; 
    UDMAMSP432_ErrorFxn dmaErrorFxn; 
    uint8_t         intNum;          
    uint8_t         intPriority;     
} UDMAMSP432_HWAttrs;

typedef struct UDMAMSP432_Config {
    void              *object;            
    void const        *hwAttrs;           
} UDMAMSP432_Config;

typedef struct UDMAMSP432_Config      *UDMAMSP432_Handle;

typedef struct UDMAMSP432_Object {
    bool unused;
} UDMAMSP432_Object;

typedef struct UDMAMSP432_Transfer {
    uint32_t         dmaChannel;                 
    uint32_t         structSelect;               
    uint32_t         ctlOptions;                 
    uint32_t         transferMode;               
    void             *dmaTransferSource;         
    void             *dmaTransferDestination;    
    uint32_t         transferSize;               
} UDMAMSP432_Transfer;

typedef struct UDMAMSP432_PingPongTransfer {
    uint32_t         dmaChannel;                  
    uint32_t         ctlOptions;                  
    uint32_t         transferMode;                
    void             *dmaTransferSource;          
    void             *dmaPrimaryDestination;      
    void             *dmaAlternateDestination;    
    uint32_t         transferSize;                
} UDMAMSP432_PingPongTransfer;

extern void UDMAMSP432_close(UDMAMSP432_Handle handle, uint32_t channelNum, uint8_t intNum);
extern void UDMAMSP432_init();

extern UDMAMSP432_Handle UDMAMSP432_open(uint32_t channelNum, uint8_t intNum, uint32_t priority,
            void (*hwiFxn)(uintptr_t), uintptr_t arg);

extern bool UDMAMSP432_setupTransfer(UDMAMSP432_Transfer *transfer);

extern bool UDMAMSP432_setupPingPongTransfer(UDMAMSP432_PingPongTransfer *transfer);

extern void UDMAMSP432_PingPongToggleBuffer(UDMAMSP432_PingPongTransfer *transfer);

#ifdef __cplusplus
}
#endif

#endif /* ti_drivers_dma_UDMAMSP432__include */