STM32469I_EVAL BSP User Manual: stm32469i_eval_camera.h Source File

00001 /**
00002   ******************************************************************************
00003   * @file    stm32469i_eval_camera.h
00004   * @author  MCD Application Team
00005   * @version V1.0.2
00006   * @date    12-January-2016
00007   * @brief   This file contains the common defines and functions prototypes for
00008   *          the stm32469i_eval_camera.c driver.
00009   ******************************************************************************
00010   * @attention
00011   *
00012   * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013   *
00014   * Redistribution and use in source and binary forms, with or without modification,
00015   * are permitted provided that the following conditions are met:
00016   *   1. Redistributions of source code must retain the above copyright notice,
00017   *      this list of conditions and the following disclaimer.
00018   *   2. Redistributions in binary form must reproduce the above copyright notice,
00019   *      this list of conditions and the following disclaimer in the documentation
00020   *      and/or other materials provided with the distribution.
00021   *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022   *      may be used to endorse or promote products derived from this software
00023   *      without specific prior written permission.
00024   *
00025   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028   * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029   * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030   * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031   * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032   * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035   *
00036   ******************************************************************************
00037   */
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 #ifndef __STM32469I_EVAL_CAMERA_H
00041 #define __STM32469I_EVAL_CAMERA_H
00042 
00043 #ifdef __cplusplus
00044  extern "C" {
00045 #endif
00046 
00047 /* Includes ------------------------------------------------------------------*/
00048 /* Include Camera component Driver */
00049 #include "../Components/s5k5cag/s5k5cag.h"
00050 
00051 /* Include IO Driver */
00052 #include "stm32469i_eval_io.h"
00053 
00054 /** @addtogroup BSP
00055   * @{
00056   */
00057 
00058 /** @addtogroup STM32469I_EVAL
00059   * @{
00060   */
00061 
00062 /** @addtogroup STM32469I-EVAL_CAMERA
00063   * @{
00064   */
00065 
00066 /** @defgroup STM32469I-EVAL_CAMERA_Exported_Types STM32469I EVAL CAMERA Exported Types
00067   * @{
00068   */
00069 
00070 /**
00071   * @brief  Camera State structures definition
00072   */
00073 typedef enum
00074 {
00075   CAMERA_OK            = 0x00,
00076   CAMERA_ERROR         = 0x01,
00077   CAMERA_TIMEOUT       = 0x02,
00078   CAMERA_NOT_DETECTED  = 0x03,
00079   CAMERA_NOT_SUPPORTED = 0x04
00080 
00081 } Camera_StatusTypeDef;
00082 
00083 /**
00084   * @brief  Camera Image rotation definition
00085   *         in frame buffer for LCD Display.
00086   */
00087 typedef enum
00088 {
00089   CAMERA_NO_ROTATION       = 0x00,
00090   CAMERA_ROTATION_90       = 0x01,
00091   CAMERA_ROTATION_INVALID  = 0x02
00092 
00093 } Camera_RotationTypeDef;
00094 
00095 #define RESOLUTION_R160x120      CAMERA_R160x120      /* QQVGA Resolution     */
00096 #define RESOLUTION_R320x240      CAMERA_R320x240      /* QVGA Resolution      */
00097 #define RESOLUTION_R480x272      CAMERA_R480x272      /* 480x272 Resolution   */
00098 #define RESOLUTION_R640x480      CAMERA_R640x480      /* VGA Resolution       */
00099 
00100 #define CAMERA_VGA_RES_X          640
00101 #define CAMERA_VGA_RES_Y          480
00102 #define CAMERA_480x272_RES_X      480
00103 #define CAMERA_480x272_RES_Y      272
00104 #define CAMERA_QVGA_RES_X         320
00105 #define CAMERA_QVGA_RES_Y         240
00106 #define CAMERA_QQVGA_RES_X        160
00107 #define CAMERA_QQVGA_RES_Y        120
00108 
00109 /**
00110   * @}
00111   */
00112 
00113 /** @defgroup STM32469I-EVAL_CAMERA_Exported_Constants STM32469I EVAL CAMERA Exported Constants
00114   * @{
00115   */
00116 /**
00117   * @}
00118   */
00119 
00120 /** @defgroup STM32469I-EVAL_CAMERA_Exported_Functions STM32469I EVAL CAMERA Exported Functions
00121   * @{
00122   */
00123 
00124 uint8_t  BSP_CAMERA_SetRotation(uint32_t rotation);
00125 uint32_t BSP_CAMERA_GetRotation(void);
00126 
00127 uint8_t BSP_CAMERA_Init(uint32_t Resolution);
00128 uint8_t BSP_CAMERA_DeInit(void);
00129 void    BSP_CAMERA_ContinuousStart(uint8_t *buff);
00130 void    BSP_CAMERA_SnapshotStart(uint8_t *buff);
00131 void    BSP_CAMERA_Suspend(void);
00132 void    BSP_CAMERA_Resume(void);
00133 uint8_t BSP_CAMERA_Stop(void);
00134 void    BSP_CAMERA_HwReset(void);
00135 void    BSP_CAMERA_PwrDown(void);
00136 void    BSP_CAMERA_LineEventCallback(void);
00137 void    BSP_CAMERA_VsyncEventCallback(void);
00138 void    BSP_CAMERA_FrameEventCallback(void);
00139 void    BSP_CAMERA_ErrorCallback(void);
00140 
00141 /* Camera features functions prototype */
00142 void    BSP_CAMERA_ContrastBrightnessConfig(uint32_t contrast_level, uint32_t brightness_level);
00143 void    BSP_CAMERA_BlackWhiteConfig(uint32_t Mode);
00144 void    BSP_CAMERA_ColorEffectConfig(uint32_t Effect);
00145 
00146 /* To be called in DCMI_IRQHandler function */
00147 void    BSP_CAMERA_IRQHandler(void);
00148 
00149 /* To be called in DMA2_Stream1_IRQHandler function */
00150 void    BSP_CAMERA_DMA_IRQHandler(void);
00151 /* These functions can be modified in case the current settings (e.g. DMA stream)
00152    need to be changed for specific application needs */
00153 void BSP_CAMERA_MspInit(DCMI_HandleTypeDef *hdcmi, void *Params);
00154 void BSP_CAMERA_MspDeInit(DCMI_HandleTypeDef *hdcmi, void *Params);
00155 
00156 /**
00157   * @}
00158   */
00159 
00160 /**
00161   * @}
00162   */
00163 
00164 /**
00165   * @}
00166   */
00167 
00168 /**
00169   * @}
00170   */
00171 
00172 #ifdef __cplusplus
00173 }
00174 #endif
00175 
00176 #endif /* __STM32469I_EVAL_CAMERA_H */
00177 
00178 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/