MPP Programming Interface Reference Manual  jpl-r3.3.15
mpi_dip_sns.h File Reference

MPI for DIP sensor. More...

#include "mpi_dip_types.h"

Data Structures

struct  MPI_PARL_LANE_INFO_S
 Struct for parallel LVDS lane info. More...
 
struct  MPI_SERL_LANE_INFO_S
 Struct for serial LVDS lane info. More...
 
struct  MPI_OB_CONF_S
 Struct for the configuration of optical black region. More...
 
struct  MPI_SNS_OUT_DVP_S
 Struct for the info of sensor output for DVP interface. More...
 
struct  MPI_SNS_OUT_HISPI_S
 Struct for the info of sensor output for HiSPI interface. More...
 
struct  MPI_SNS_OUT_SONYLVDS_S
 Struct for the info of sensor output for SONY-LVDS interface. More...
 
struct  MPI_SNS_OUT_PANLVDS_S
 Struct for the info of sensor output for PANASONIC-LVDS interface. More...
 
struct  MPI_SNS_OUT_MIPI_S
 Struct for the info of sensor output for MIPI interface. More...
 
struct  MPI_SNS_OP_INFO_S
 Struct for the attribute of sensor operation info. More...
 
struct  MPI_AE_SNS_DEFAULT_S
 Auto exposure sensor parameters. More...
 
struct  MPI_ISO_SNS_DEFAULT_S
 Effective iso information. More...
 
struct  MPI_AWB_COLOR_TEMP_S
 Color temperature information. More...
 
struct  MPI_AWB_COLOR_DELTA_S
 Difference color temperature gain information. More...
 
struct  MPI_AWB_SNS_DEFAULT_S
 Auto white balance sensor parameters. More...
 
struct  MPI_DBC_SNS_DEFAULT_S
 Device black level sensor parameters. More...
 
struct  MPI_LSC_SNS_DEFAULT_S
 Lens shadding correction sensor parameters. More...
 
struct  MPI_DCC_SNS_DEFAULT_S
 Device color correction sensor parameters. More...
 
struct  MPI_SHP_SNS_DEFAULT_S
 Sharpness sensor parameters. More...
 
struct  MPI_NR_SNS_DEFAULT_S
 Noise reduction sensor parameters. More...
 
struct  MPI_CSM_SNS_DEFAULT_S
 Color saturation management sensor parameters. More...
 
struct  MPI_TE_SNS_DEFAULT_S
 Default tone curve. More...
 
struct  MPI_GAMMA_SNS_DEFAULT_S
 Gamma sensor parameters. More...
 
struct  MPI_DIP_SNS_DEFAULT_S
 Defines the structure of DIP sensor parameters. More...
 
struct  MPI_CAL_SNS_DEFAULT_S
 Defines the structure of CAL sensor parameters. More...
 
struct  MPI_BLACK_LEVEL_TABLE_S
 Defines the structure of Black level table. More...
 
struct  MPI_I2C_DATA_S
 Sensor I2C message description. More...
 
union  MPI_CTRL_BUS_S
 Sensor bus description. More...
 
struct  MPI_SNS_REGS_TABLE_S
 Structure to record sensor register configuration. More...
 
struct  DIP_SNS_CALLBACK_S
 Structure to record sensor register configuration. More...
 
struct  CAL_SNS_CALLBACK_S
 Structure to record sensor register configuration. More...
 
struct  AE_SNS_CALLBACK_S
 Structure to record sensor register configuration. More...
 
struct  AWB_SNS_CALLBACK_S
 Structure to record sensor register configuration. More...
 
struct  MPI_SNS_CALLBACK_S
 Structure to record sensor register configuration. More...
 
struct  SERL_LANE_DELAY_S
 Structure to decide LVDS delay. More...
 
struct  SERL_DATA_LANES_DELAY_S
 Structure to decide all LVDS lanes delay. More...
 

Macros

#define LVDS_CALIB_FILE   "/calib/factory_default/lvds_delay"
 

Typedefs

typedef MPI_I2C_DATA_S MPI_SPI_DATA_S
 SPI message description.
 

Enumerations

enum  MPI_BUS_TYPE_E { BUS_TYPE_I2C, BUS_TYPE_SPI, BUS_TYPE_NUM }
 Enumeration of control bus type. More...
 
enum  MPI_BIT_WIDTH_E {
  MPI_BITS_16, MPI_BITS_14, MPI_BITS_12, MPI_BITS_10,
  MPI_BITS_9, MPI_BITS_8, MPI_BITS_7, MPI_BITS_6,
  MPI_BITS_NUM
}
 Enumeration of raw bit width. More...
 
enum  MPI_MSB_FIRST_E { MPI_LSB_FIRST, MPI_MSB_FIRST }
 Enumeration of raw bit width. More...
 
enum  MPI_LANE_TYPE_E {
  MPI_LANE_TYPE_DATA_0, MPI_LANE_TYPE_DATA_1, MPI_LANE_TYPE_DATA_2, MPI_LANE_TYPE_DATA_3,
  MPI_LANE_TYPE_CLOCK, MPI_LANE_TYPE_UNUSED
}
 Enumeration of LVDS lane type. More...
 
enum  MPI_LANE_DELAY_E {
  MPI_LANE_DELAY_0, MPI_LANE_DELAY_1, MPI_LANE_DELAY_2, MPI_LANE_DELAY_3,
  MPI_LANE_DELAY_4, MPI_LANE_DELAY_5, MPI_LANE_DELAY_6, MPI_LANE_DELAY_7,
  MPI_LANE_DELAY_8, MPI_LANE_DELAY_9, MPI_LANE_DELAY_10, MPI_LANE_DELAY_11,
  MPI_LANE_DELAY_12, MPI_LANE_DELAY_13, MPI_LANE_DELAY_14, MPI_LANE_DELAY_15,
  MPI_LANE_DELAY_16, MPI_LANE_DELAY_17, MPI_LANE_DELAY_18, MPI_LANE_DELAY_19,
  MPI_LANE_DELAY_20, MPI_LANE_DELAY_21, MPI_LANE_DELAY_22, MPI_LANE_DELAY_23,
  MPI_LANE_DELAY_24, MPI_LANE_DELAY_25, MPI_LANE_DELAY_26, MPI_LANE_DELAY_27,
  MPI_LANE_DELAY_28, MPI_LANE_DELAY_29, MPI_LANE_DELAY_30, MPI_LANE_DELAY_31,
  MPI_LANE_DELAY_NUM
}
 Enumeration of LVDS lane delay. More...
 
enum  MPI_IMPD_SEL_E { MPI_IMPD_SEL_ON_CHIP, MPI_IMPD_SEL_OFF_CHIP }
 Enumeration of termination impedance selection. More...
 
enum  MPI_INTF_PTCL_E {
  MPI_INTF_PTCL_HISPI = 0x0, MPI_INTF_PTCL_SONY_LVDS = 0x1, MPI_INTF_PTCL_PAN_LVDS = 0x2, MPI_INTF_PTCL_MIPI = 0x4,
  MPI_INTF_PTCL_DVP = 0x8, MPI_INTF_PTCL_NUM = 0xF
}
 Enumeration of sensor interface protocol. More...
 
enum  MPI_PTCL_MODE_E {
  MPI_PTCL_MODE_NONE = 0, MPI_MIPI_CSI2 = 0, MPI_HISPI_PKTZ_SP = 0, MPI_HISPI_STRM_SP = 1,
  MPI_HISPI_STRM_S = 2, MPI_SONY_LVDS_DDR = 2, MPI_PAN_LVDS_DDR = 2
}
 Enumeration of modes of sensor interface protocols. More...
 
enum  MPI_SNS_MODE_E { MPI_SNS_MODE_MASTER, MPI_SNS_MODE_SLAVE, MPI_SNS_MODE_NUM }
 Enumeration of sensor operation mode. More...
 
enum  MPI_SLV_SYNC_SRC_E { MPI_SLV_SYNC_SRC_NONE, MPI_SLV_SYNC_SRC_MAIN, MPI_SLV_SYNC_SRC_SUB }
 Enumeration of sensor slave mode sync signal source. More...
 
enum  MPI_SYNC_PLTY_E { MPI_PLTY_HIGH, MPI_PLTY_LOW, MPI_PLTY_NUM }
 Enumeration of synchronization polarity of sensor interface. More...
 
enum  MPI_VOLT_E { MPI_VOLT_1P8V, MPI_VOLT_3P3V }
 Enumeration of voltage. More...
 

Functions

INT32 MPI_regSnsCallback (MPI_PATH idx, INT32 sns_id, const MPI_SNS_CALLBACK_S *p_sns_cb)
 Register sensor callback functions to a input path. More...
 
INT32 MPI_deregSnsCallback (MPI_PATH idx, INT32 sns_id)
 Deregister sensor callback functions to the a input path. More...
 

Detailed Description

MPI for DIP sensor.

Macro Definition Documentation

#define LVDS_CALIB_FILE   "/calib/factory_default/lvds_delay"

The file path of LVDS calibration.

Enumeration Type Documentation

Enumeration of raw bit width.

Enumerator
MPI_BITS_16 

16 bits.

MPI_BITS_14 

14 bits.

MPI_BITS_12 

12 bits.

MPI_BITS_10 

10 bits.

MPI_BITS_9 

9 bits.

MPI_BITS_8 

8 bits.

MPI_BITS_7 

7 bits.

MPI_BITS_6 

6 bits.

Enumeration of control bus type.

Enumerator
BUS_TYPE_I2C 

I2C bus.

BUS_TYPE_SPI 

SPI bus.

Enumeration of termination impedance selection.

Enumerator
MPI_IMPD_SEL_ON_CHIP 

On chip termination.

MPI_IMPD_SEL_OFF_CHIP 

Off chip termination.

Enumeration of sensor interface protocol.

Enumerator
MPI_INTF_PTCL_HISPI 

HiSPI.

MPI_INTF_PTCL_SONY_LVDS 

SONY-LVDS.

MPI_INTF_PTCL_PAN_LVDS 

PANASONIC-LVDS.

MPI_INTF_PTCL_MIPI 

MIPI.

MPI_INTF_PTCL_DVP 

DVP.

MPI_INTF_PTCL_NUM 

The number of interface type.

Enumeration of LVDS lane delay.

Enumerator
MPI_LANE_DELAY_0 

LVDS lane delay step 0.

MPI_LANE_DELAY_1 

LVDS lane delay step 1.

MPI_LANE_DELAY_2 

LVDS lane delay step 2.

MPI_LANE_DELAY_3 

LVDS lane delay step 3.

MPI_LANE_DELAY_4 

LVDS lane delay step 4.

MPI_LANE_DELAY_5 

LVDS lane delay step 5.

MPI_LANE_DELAY_6 

LVDS lane delay step 6.

MPI_LANE_DELAY_7 

LVDS lane delay step 7.

MPI_LANE_DELAY_8 

LVDS lane delay step 8.

MPI_LANE_DELAY_9 

LVDS lane delay step 9.

MPI_LANE_DELAY_10 

LVDS lane delay step 10.

MPI_LANE_DELAY_11 

LVDS lane delay step 11.

MPI_LANE_DELAY_12 

LVDS lane delay step 12.

MPI_LANE_DELAY_13 

LVDS lane delay step 13.

MPI_LANE_DELAY_14 

LVDS lane delay step 14.

MPI_LANE_DELAY_15 

LVDS lane delay step 15.

MPI_LANE_DELAY_16 

LVDS lane delay step 16.

MPI_LANE_DELAY_17 

LVDS lane delay step 17.

MPI_LANE_DELAY_18 

LVDS lane delay step 18.

MPI_LANE_DELAY_19 

LVDS lane delay step 19.

MPI_LANE_DELAY_20 

LVDS lane delay step 20.

MPI_LANE_DELAY_21 

LVDS lane delay step 21.

MPI_LANE_DELAY_22 

LVDS lane delay step 22.

MPI_LANE_DELAY_23 

LVDS lane delay step 23.

MPI_LANE_DELAY_24 

LVDS lane delay step 24.

MPI_LANE_DELAY_25 

LVDS lane delay step 25.

MPI_LANE_DELAY_26 

LVDS lane delay step 26.

MPI_LANE_DELAY_27 

LVDS lane delay step 27.

MPI_LANE_DELAY_28 

LVDS lane delay step 28.

MPI_LANE_DELAY_29 

LVDS lane delay step 29.

MPI_LANE_DELAY_30 

LVDS lane delay step 30.

MPI_LANE_DELAY_31 

LVDS lane delay step 31.

Enumeration of LVDS lane type.

Enumerator
MPI_LANE_TYPE_DATA_0 

LVDS data lane 0.

MPI_LANE_TYPE_DATA_1 

LVDS data lane 1.

MPI_LANE_TYPE_DATA_2 

LVDS data lane 2.

MPI_LANE_TYPE_DATA_3 

LVDS data lane 3.

MPI_LANE_TYPE_CLOCK 

LVDS clock lane.

MPI_LANE_TYPE_UNUSED 

Unused lane.

Enumeration of raw bit width.

Enumerator
MPI_LSB_FIRST 

Least significant bit first

MPI_MSB_FIRST 

Most significant bit first

Enumeration of modes of sensor interface protocols.

Enumerator
MPI_PTCL_MODE_NONE 

No specified protocol mode.

MPI_MIPI_CSI2 

MIPI CSI2 procotol.

MPI_HISPI_PKTZ_SP 

HiSPI packtized SP protocol.

MPI_HISPI_STRM_SP 

HiSPI streaming SP protocol.

MPI_HISPI_STRM_S 

HiSPI streaming S protocol.

MPI_SONY_LVDS_DDR 

SONY-LVDS DDR protocol.

MPI_PAN_LVDS_DDR 

PANASONIC-LVDS DDR protocol.

Enumeration of sensor slave mode sync signal source.

Enumerator
MPI_SLV_SYNC_SRC_NONE 

Not select any signal source.

MPI_SLV_SYNC_SRC_MAIN 

Select sync signal from main LVDS.

MPI_SLV_SYNC_SRC_SUB 

Select sync signal from sub LVDS.

Enumeration of sensor operation mode.

Enumerator
MPI_SNS_MODE_MASTER 

Sensor master mode.

MPI_SNS_MODE_SLAVE 

Sensor slave mode.

Enumeration of synchronization polarity of sensor interface.

Enumerator
MPI_PLTY_HIGH 

Polarity high.

MPI_PLTY_LOW 

Polarity low.

enum MPI_VOLT_E

Enumeration of voltage.

Enumerator
MPI_VOLT_1P8V 

Voltage 1.8V.

MPI_VOLT_3P3V 

Voltage 3.3V.

Function Documentation

INT32 MPI_deregSnsCallback ( MPI_PATH  idx,
int32_t  sns_id 
)

Deregister sensor callback functions to the a input path.

Parameters
[in]idxinput path index.
[in]sns_idsensor identity.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_regSensorCallback()
INT32 MPI_regSnsCallback ( MPI_PATH  idx,
int32_t  sns_id,
const MPI_SNS_CALLBACK_S p_sns_cb 
)

Register sensor callback functions to a input path.

Parameters
[in]idxinput path index.
[in]sns_idsensor identity.
[in]p_sns_cbpointer to the sensor callback function.
Returns
The execution result.
Return values
MPI_SUCCESSsuccess
othersfailure
See also
MPI_deregSensorCallback()