udma_types.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2018-2021 Texas Instruments Incorporated
 *
 *  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 UDMA_TYPES_H_
#define UDMA_TYPES_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
typedef void *                          Udma_DrvHandle;
typedef void *                          Udma_ChHandle;
typedef void *                          Udma_EventHandle;
typedef void *                          Udma_RingHandle;
typedef void *                          Udma_FlowHandle;
#if (UDMA_SOC_CFG_RING_MON_PRESENT == 1)
 
typedef struct Udma_RingMonObj *        Udma_RingMonHandle;
#endif
 
#define UDMA_CACHELINE_ALIGNMENT        (128U)
 
#define UDMA_ALIGN_SIZE(x)              (((x) + UDMA_CACHELINE_ALIGNMENT) & ~(UDMA_CACHELINE_ALIGNMENT - 1U))
 
#define UDMA_DEFAULT_CH_DISABLE_TIMEOUT (100U)
 
#define UDMA_SOK                        ( (int32_t) (0))
 
#define UDMA_EFAIL                      (-(int32_t) (1))
 
#define UDMA_EBADARGS                   (-(int32_t) (2))
 
#define UDMA_EINVALID_PARAMS            (-(int32_t) (3))
 
#define UDMA_ETIMEOUT                   (-(int32_t) (4))
 
#define UDMA_EALLOC                     (-(int32_t) (5))
 
#define UDMA_INST_ID_0                  (0U)
#define UDMA_INST_ID_1                  (1U)
#define UDMA_INST_ID_2                  (2U)
#define UDMA_INST_ID_3                  (3U)
 
#define UDMA_UTC_ID0                    (0U)
#define UDMA_UTC_ID1                    (1U)
#define UDMA_UTC_ID2                    (2U)
#define UDMA_UTC_ID3                    (3U)
 
#define UDMA_MAPPED_GROUP0              (0U)
#define UDMA_MAPPED_GROUP1              (1U)
#define UDMA_MAPPED_GROUP2              (2U)
#define UDMA_MAPPED_GROUP3              (3U)
#define UDMA_MAPPED_GROUP4              (4U)
#define UDMA_MAPPED_GROUP5              (5U)
#define UDMA_MAPPED_GROUP6              (6U)
#define UDMA_MAPPED_GROUP7              (7U)
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
/* None */
 
/* ========================================================================== */
/*                       Static Function Definitions                          */
/* ========================================================================== */
 
/* None */
 
#ifdef __cplusplus
}
#endif
 
#endif /* #ifndef UDMA_TYPES_H_ */