CC3200 Peripheral Driver Library User's Guide  1.2.0
camera.h
1 //*****************************************************************************
2 //
3 // camera.h
4 //
5 // Prototypes and macros for the camera controller module.
6 //
7 // Copyright (C) 2014 Texas Instruments Incorporated - https://www.ti.com/
8 //
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions
12 // are met:
13 //
14 // Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the
20 // distribution.
21 //
22 // Neither the name of Texas Instruments Incorporated nor the names of
23 // its contributors may be used to endorse or promote products derived
24 // from this software without specific prior written permission.
25 //
26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
27 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
28 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
29 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
30 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
31 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
32 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
36 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37 //
38 //*****************************************************************************
39 
40 #ifndef __CAMERA_H__
41 #define __CAMERA_H__
42 
43 //*****************************************************************************
44 //
45 // If building with a C++ compiler, make all of the definitions in this header
46 // have a C binding.
47 //
48 //*****************************************************************************
49 #ifdef __cplusplus
50 extern "C"
51 {
52 #endif
53 
54 //*****************************************************************************
55 // Macro defining Camera buffer address
56 //*****************************************************************************
57 #define CAM_BUFFER_ADDR 0x44018100
58 
59 
60 //*****************************************************************************
61 // Value that can be passed to CameraXClkSet().
62 //*****************************************************************************
63 #define CAM_XCLK_STABLE_LO 0x00
64 #define CAM_XCLK_STABLE_HI 0x01
65 #define CAM_XCLK_DIV_BYPASS 0x02
66 
67 
68 //*****************************************************************************
69 // Value that can be passed to CameraIntEnable(), CameraIntDisable,
70 // CameraIntClear() or returned from CameraIntStatus().
71 //*****************************************************************************
72 #define CAM_INT_DMA 0x80000000
73 #define CAM_INT_FE 0x00010000
74 #define CAM_INT_FIFO_NOEMPTY 0x00000010
75 #define CAM_INT_FIFO_FULL 0x00000008
76 #define CAM_INT_FIFO_THR 0x00000004
77 #define CAM_INT_FIFO_OF 0x00000002
78 #define CAN_INT_FIFO_UR 0x00000001
79 
80 
81 //*****************************************************************************
82 // Value that can be passed to CameraXClkConfig().
83 //*****************************************************************************
84 #define CAM_HS_POL_HI 0x00000000
85 #define CAM_HS_POL_LO 0x00000200
86 #define CAM_VS_POL_HI 0x00000000
87 #define CAM_VS_POL_LO 0x00000100
88 
89 #define CAM_PCLK_RISE_EDGE 0x00000000
90 #define CAM_PCLK_FALL_EDGE 0x00000400
91 
92 #define CAM_ORDERCAM_SWAP 0x00000800
93 #define CAM_NOBT_SYNCHRO 0x00002000
94 #define CAM_IF_SYNCHRO 0x00080000
95 
96 
97 //*****************************************************************************
98 //
99 // API Function prototypes
100 //
101 //*****************************************************************************
102 extern void CameraReset(unsigned long ulBase);
103 extern void CameraParamsConfig(unsigned long ulBase, unsigned long ulHSPol,
104  unsigned long ulVSPol, unsigned long ulFlags);
105 extern void CameraXClkConfig(unsigned long ulBase, unsigned long ulCamClkIn,
106  unsigned long ulXClk);
107 extern void CameraXClkSet(unsigned long ulBase, unsigned char bXClkFlags);
108 extern void CameraDMAEnable(unsigned long ulBase);
109 extern void CameraDMADisable(unsigned long ulBase);
110 extern void CameraThresholdSet(unsigned long ulBase, unsigned long ulThreshold);
111 extern void CameraIntRegister(unsigned long ulBase, void (*pfnHandler)(void));
112 extern void CameraIntUnregister(unsigned long ulBase);
113 extern void CameraIntEnable(unsigned long ulBase, unsigned long ulIntFlags);
114 extern void CameraIntDisable(unsigned long ulBase, unsigned long ulIntFlags);
115 extern unsigned long CameraIntStatus(unsigned long ulBase);
116 extern void CameraIntClear(unsigned long ulBase, unsigned long ulIntFlags);
117 extern void CameraCaptureStop(unsigned long ulBase, tBoolean bImmediate);
118 extern void CameraCaptureStart(unsigned long ulBase);
119 extern void CameraBufferRead(unsigned long ulBase,unsigned long *pBuffer,
120  unsigned char ucSize);
121 
122 //*****************************************************************************
123 //
124 // Mark the end of the C bindings section for C++ compilers.
125 //
126 //*****************************************************************************
127 #ifdef __cplusplus
128 }
129 #endif
130 
131 #endif //__CAMERA_H__
void CameraReset(unsigned long ulBase)
Definition: camera.c:66
void CameraBufferRead(unsigned long ulBase, unsigned long *pBuffer, unsigned char ucSize)
Definition: camera.c:577
void CameraIntRegister(unsigned long ulBase, void(*pfnHandler)(void))
Definition: camera.c:323
unsigned long CameraIntStatus(unsigned long ulBase)
Definition: camera.c:445
void CameraXClkConfig(unsigned long ulBase, unsigned long ulCamClkIn, unsigned long ulXClk)
Definition: camera.c:156
void CameraCaptureStart(unsigned long ulBase)
Definition: camera.c:513
void CameraDMADisable(unsigned long ulBase)
Definition: camera.c:273
void CameraIntDisable(unsigned long ulBase, unsigned long ulIntFlags)
Definition: camera.c:417
void CameraCaptureStop(unsigned long ulBase, tBoolean bImmediate)
Definition: camera.c:540
void CameraIntUnregister(unsigned long ulBase)
Definition: camera.c:349
void CameraXClkSet(unsigned long ulBase, unsigned char bXClkFlags)
Definition: camera.c:211
void CameraDMAEnable(unsigned long ulBase)
Definition: camera.c:253
void CameraIntClear(unsigned long ulBase, unsigned long ulIntFlags)
Definition: camera.c:484
void CameraThresholdSet(unsigned long ulBase, unsigned long ulThreshold)
Definition: camera.c:296
void CameraParamsConfig(unsigned long ulBase, unsigned long ulHSPol, unsigned long ulVSPol, unsigned long ulFlags)
Definition: camera.c:114
void CameraIntEnable(unsigned long ulBase, unsigned long ulIntFlags)
Definition: camera.c:386