205d16158e24eb7442a976cd6d8ddc37147fb5b6
[processor-sdk/pdk.git] / packages / ti / drv / adcbuf / src / adcbuf_mmwave.h
1 /**
2  *   @file  adcbuf_mmwave.h
3  *
4  *   @brief
5  *      This is the internal Header for mmWave ADCBUF Driver. This header
6  *      file should *NOT* be directly included by applications.
7  *
8  *  \par
9  *  NOTE:
10  *      (C) Copyright 2016 Texas Instruments, Inc.
11  *
12  *  Redistribution and use in source and binary forms, with or without
13  *  modification, are permitted provided that the following conditions
14  *  are met:
15  *
16  *    Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  *
19  *    Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the
22  *    distribution.
23  *
24  *    Neither the name of Texas Instruments Incorporated nor the names of
25  *    its contributors may be used to endorse or promote products derived
26  *    from this software without specific prior written permission.
27  *
28  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
31  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
32  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
33  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
34  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
35  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
36  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
37  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
38  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39  */
41 #ifndef ADCBUF_MMWAVE_H
42 #define ADCBUF_MMWAVE_H
44 #include <ti/osal/HwiP.h>
45 #include <ti/osal/DebugP.h>
46 #include <ti/osal/SemaphoreP.h>
47 #include <ti/csl/soc.h>
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
54 /**
55  * @brief    ADCBUF Driver HW configuration
56  *
57  * @details
58  *  The structure is used to store the hardware specific configuration which is
59  *  passed to each driver instance
60  *
61  *  \ingroup ADCBUF_DRIVER_INTERNAL_DATA_STRUCTURE
62  *
63  */
64 typedef const struct ADCBuf_HwCfg_t
65 {
66     /**
67      * @brief   Base address of the DSS_REG registers.
68      */
69         CSL_rss_ctrlRegs*  ptrRSSCtrlRegBase;
71     /**
72      * @brief   Interrupt Number
73      */
74     uint32_t           interruptNum;
76     /**
77      * @brief   ADC Buffer base address
78      */
79     uint32_t           ptrADCBUFBaseAddr;
81     /**
82      * @brief   ADC Buffer base address
83      */
84     uint32_t           ptrCQBUFBaseAddr;
85 }ADCBuf_HwCfg;
87 /**
88  *  @brief      ADCBufMMWave Object
89  *
90  *  The application must not access any member variables of this structure!
91  *
92  *  \ingroup ADCBUF_DRIVER_INTERNAL_DATA_STRUCTURE
93  *
94  */
95 typedef struct ADCBufMMWave_Object_t
96 {
97     /**
98       * @brief   Status of ADCBUF driver.
99      */
100     bool                   isOpen;
102      /**
103       * @brief   Base address of DSS Register Base.
104      */
105     CSL_rss_ctrlRegs       *ptrRssCtrlRegBase;
107 } ADCBufMMWave_Object, *ADCBufMMWave_Handle;
109 #ifdef __cplusplus
111 #endif
113 #endif /* ADCBUF_MMWAVE_H */