STM32L4xx_HAL_Driver  1.14.0
stm32l4xx_hal_dcmi.h File Reference

Header file of DCMI HAL module. More...

Go to the source code of this file.

Data Structures

struct  DCMI_SyncUnmaskTypeDef
 DCMI Embedded Synchronisation CODE Init structure definition. More...
 
struct  DCMI_InitTypeDef
 DCMI Init structure definition. More...
 
struct  __DCMI_HandleTypeDef
 DCMI handle Structure definition. More...
 

Typedefs

typedef struct __DCMI_HandleTypeDef DCMI_HandleTypeDef
 DCMI handle Structure definition. More...
 
typedef void(* pDCMI_CallbackTypeDef) (DCMI_HandleTypeDef *hdcmi)
 

Enumerations

enum  HAL_DCMI_StateTypeDef {
  HAL_DCMI_STATE_RESET = 0x00U, HAL_DCMI_STATE_READY = 0x01U, HAL_DCMI_STATE_BUSY = 0x02U, HAL_DCMI_STATE_TIMEOUT = 0x03U,
  HAL_DCMI_STATE_ERROR = 0x04U, HAL_DCMI_STATE_SUSPENDED = 0x05U
}
 HAL DCMI State structures definition. More...
 
enum  HAL_DCMI_CallbackIDTypeDef {
  HAL_DCMI_FRAME_EVENT_CB_ID = 0x00U, HAL_DCMI_VSYNC_EVENT_CB_ID = 0x01U, HAL_DCMI_LINE_EVENT_CB_ID = 0x02U, HAL_DCMI_ERROR_CB_ID = 0x03U,
  HAL_DCMI_MSPINIT_CB_ID = 0x04U, HAL_DCMI_MSPDEINIT_CB_ID = 0x05U
}
 

Functions

HAL_StatusTypeDef HAL_DCMI_Init (DCMI_HandleTypeDef *hdcmi)
 Initialize the DCMI according to the specified parameters in the DCMI_InitTypeDef and create the associated handle. More...
 
HAL_StatusTypeDef HAL_DCMI_DeInit (DCMI_HandleTypeDef *hdcmi)
 De-initialize the DCMI peripheral, reset control registers to their default values. More...
 
void HAL_DCMI_MspInit (DCMI_HandleTypeDef *hdcmi)
 Initialize the DCMI MSP. More...
 
void HAL_DCMI_MspDeInit (DCMI_HandleTypeDef *hdcmi)
 De-initialize the DCMI MSP. More...
 
HAL_StatusTypeDef HAL_DCMI_RegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID, pDCMI_CallbackTypeDef pCallback)
 DCMI Callback registering. More...
 
HAL_StatusTypeDef HAL_DCMI_UnRegisterCallback (DCMI_HandleTypeDef *hdcmi, HAL_DCMI_CallbackIDTypeDef CallbackID)
 DCMI Callback Unregistering. More...
 
HAL_StatusTypeDef HAL_DCMI_Start_DMA (DCMI_HandleTypeDef *hdcmi, uint32_t DCMI_Mode, uint32_t pData, uint32_t Length)
 Enable DCMI capture in DMA mode. More...
 
HAL_StatusTypeDef HAL_DCMI_Stop (DCMI_HandleTypeDef *hdcmi)
 Disable DCMI capture in DMA mode. More...
 
HAL_StatusTypeDef HAL_DCMI_Suspend (DCMI_HandleTypeDef *hdcmi)
 Suspend DCMI capture. More...
 
HAL_StatusTypeDef HAL_DCMI_Resume (DCMI_HandleTypeDef *hdcmi)
 Resume DCMI capture. More...
 
void HAL_DCMI_ErrorCallback (DCMI_HandleTypeDef *hdcmi)
 Error DCMI callback. More...
 
void HAL_DCMI_LineEventCallback (DCMI_HandleTypeDef *hdcmi)
 Line Event callback. More...
 
void HAL_DCMI_FrameEventCallback (DCMI_HandleTypeDef *hdcmi)
 Frame Event callback. More...
 
void HAL_DCMI_VsyncEventCallback (DCMI_HandleTypeDef *hdcmi)
 VSYNC Event callback. More...
 
void HAL_DCMI_IRQHandler (DCMI_HandleTypeDef *hdcmi)
 Handle DCMI interrupt request. More...
 
HAL_StatusTypeDef HAL_DCMI_ConfigCrop (DCMI_HandleTypeDef *hdcmi, uint32_t X0, uint32_t Y0, uint32_t XSize, uint32_t YSize)
 Configure the DCMI crop window coordinates. More...
 
HAL_StatusTypeDef HAL_DCMI_EnableCrop (DCMI_HandleTypeDef *hdcmi)
 Enable the crop feature. More...
 
HAL_StatusTypeDef HAL_DCMI_DisableCrop (DCMI_HandleTypeDef *hdcmi)
 Disable the crop feature. More...
 
HAL_StatusTypeDef HAL_DCMI_ConfigSyncUnmask (DCMI_HandleTypeDef *hdcmi, DCMI_SyncUnmaskTypeDef *SyncUnmask)
 Set embedded synchronization delimiters unmasks. More...
 
HAL_DCMI_StateTypeDef HAL_DCMI_GetState (DCMI_HandleTypeDef *hdcmi)
 Return the DCMI state. More...
 
uint32_t HAL_DCMI_GetError (DCMI_HandleTypeDef *hdcmi)
 Return the DCMI error code. More...
 

Variables

 C
 

Detailed Description

Header file of DCMI HAL module.

Author
MCD Application Team
Attention

© Copyright (c) 2017 STMicroelectronics. All rights reserved.

This software component is licensed by ST under BSD 3-Clause license, the "License"; You may not use this file except in compliance with the License. You may obtain a copy of the License at: opensource.org/licenses/BSD-3-Clause

Definition in file stm32l4xx_hal_dcmi.h.


Data Structure Documentation

◆ DCMI_SyncUnmaskTypeDef

struct DCMI_SyncUnmaskTypeDef

DCMI Embedded Synchronisation CODE Init structure definition.

Definition at line 62 of file stm32l4xx_hal_dcmi.h.

Data Fields
uint8_t FrameEndUnmask

Specifies the frame end delimiter unmask.

uint8_t FrameStartUnmask

Specifies the frame start delimiter unmask.

uint8_t LineEndUnmask

Specifies the line end delimiter unmask.

uint8_t LineStartUnmask

Specifies the line start delimiter unmask.

◆ DCMI_InitTypeDef

struct DCMI_InitTypeDef

DCMI Init structure definition.

Definition at line 74 of file stm32l4xx_hal_dcmi.h.

Data Fields
uint32_t ByteSelectMode

Specifies the data to be captured by the interface This parameter can be a value of DCMI Byte Select Mode

uint32_t ByteSelectStart

Specifies if the data to be captured by the interface is even or odd This parameter can be a value of DCMI Byte Select Start

uint32_t CaptureRate

Specifies the frequency of frame capture: All, 1/2 or 1/4. This parameter can be a value of DCMI Capture Rate

uint32_t ExtendedDataMode

Specifies the data width: 8-bit, 10-bit, 12-bit or 14-bit. This parameter can be a value of DCMI Extended Data Mode

uint32_t HSPolarity

Specifies the Horizontal synchronization polarity: High or Low. This parameter can be a value of DCMI HSYNC Polarity

uint32_t JPEGMode

Enable or Disable the JPEG mode. This parameter can be a value of DCMI_MODE_JPEG

uint32_t LineSelectMode

Specifies the line of data to be captured by the interface This parameter can be a value of DCMI Line Select Mode

uint32_t LineSelectStart

Specifies if the line of data to be captured by the interface is even or odd This parameter can be a value of DCMI Line Select Start

uint32_t PCKPolarity

Specifies the Pixel clock polarity: Falling or Rising. This parameter can be a value of DCMI Pixel Clock Polarity

DCMI_CodesInitTypeDef SynchroCode

Specifies the frame start delimiter codes.

uint32_t SynchroMode

Specifies the Synchronization Mode: Hardware or Embedded. This parameter can be a value of DCMI Synchronization Mode

uint32_t VSPolarity

Specifies the Vertical synchronization polarity: High or Low. This parameter can be a value of DCMI VSYNC Polarity

Typedef Documentation

◆ DCMI_HandleTypeDef

DCMI handle Structure definition.

◆ pDCMI_CallbackTypeDef

typedef void(* pDCMI_CallbackTypeDef) (DCMI_HandleTypeDef *hdcmi)

Definition at line 182 of file stm32l4xx_hal_dcmi.h.

Enumeration Type Documentation

◆ HAL_DCMI_CallbackIDTypeDef

Enumerator
HAL_DCMI_FRAME_EVENT_CB_ID 

DCMI Frame Event Callback ID

HAL_DCMI_VSYNC_EVENT_CB_ID 

DCMI Vsync Event Callback ID

HAL_DCMI_LINE_EVENT_CB_ID 

DCMI Line Event Callback ID

HAL_DCMI_ERROR_CB_ID 

DCMI Error Callback ID

HAL_DCMI_MSPINIT_CB_ID 

DCMI MspInit callback ID

HAL_DCMI_MSPDEINIT_CB_ID 

DCMI MspDeInit callback ID

Definition at line 171 of file stm32l4xx_hal_dcmi.h.

◆ HAL_DCMI_StateTypeDef

HAL DCMI State structures definition.

Enumerator
HAL_DCMI_STATE_RESET 

DCMI not yet initialized or disabled

HAL_DCMI_STATE_READY 

DCMI initialized and ready for use

HAL_DCMI_STATE_BUSY 

DCMI internal processing is ongoing

HAL_DCMI_STATE_TIMEOUT 

DCMI timeout state

HAL_DCMI_STATE_ERROR 

DCMI error state

HAL_DCMI_STATE_SUSPENDED 

DCMI suspend state

Definition at line 116 of file stm32l4xx_hal_dcmi.h.

Variable Documentation

◆ C

C
Initial value:
{
#endif
#if defined (DCMI)
typedef struct
{
uint8_t FrameStartCode;
uint8_t LineStartCode;
uint8_t LineEndCode;
uint8_t FrameEndCode;
}DCMI_CodesInitTypeDef
This file contains HAL common defines, enumeration, macros and structures definitions.