media: m5mols: fix some kernel-doc markups (897aa67a) · Commits · 戴 / test

drivers/media/i2c/m5mols/m5mols_capture.c

+5 −0

Original line number	Diff line number	Diff line
		@@ -33,6 +33,10 @@

		/**
		* m5mols_read_rational - I2C read of a rational number
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @addr_num: numerator register
		* @addr_den: denominator register
		* @val: place to store the division result
		*
		* Read numerator and denominator from registers @addr_num and @addr_den
		* respectively and return the division result in @val.
		@@ -53,6 +57,7 @@ static int m5mols_read_rational(struct v4l2_subdev *sd, u32 addr_num,

		/**
		* m5mols_capture_info - Gather captured image information
		* @info: M-5MOLS driver data structure
		*
		* For now it gathers only EXIF information and file size.
		*/

drivers/media/i2c/m5mols/m5mols_controls.c

+1 −0

Original line number	Diff line number	Diff line
		@@ -126,6 +126,7 @@ static struct m5mols_scenemode m5mols_default_scenemode[] = {

		/**
		* m5mols_do_scenemode() - Change current scenemode
		* @info: M-5MOLS driver data structure
		* @mode: Desired mode of the scenemode
		*
		* WARNING: The execution order is important. Do not change the order.

drivers/media/i2c/m5mols/m5mols_core.c

+18 −2

Original line number	Diff line number	Diff line
		@@ -114,7 +114,8 @@ static const struct m5mols_resolution m5mols_reg_res[] = {

		/**
		* m5mols_swap_byte - an byte array to integer conversion function
		* @size: size in bytes of I2C packet defined in the M-5MOLS datasheet
		* @data: byte array
		* @length: size in bytes of I2C packet defined in the M-5MOLS datasheet
		*
		* Convert I2C data byte array with performing any required byte
		* reordering to assure proper values for each data type, regardless
		@@ -132,8 +133,9 @@ static u32 m5mols_swap_byte(u8 *data, u8 length)

		/**
		* m5mols_read - I2C read function
		* @reg: combination of size, category and command for the I2C packet
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @size: desired size of I2C packet
		* @reg: combination of size, category and command for the I2C packet
		* @val: read value
		*
		* Returns 0 on success, or else negative errno.
		@@ -232,6 +234,7 @@ int m5mols_read_u32(struct v4l2_subdev sd, u32 reg, u32 val)

		/**
		* m5mols_write - I2C command write function
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @reg: combination of size, category and command for the I2C packet
		* @val: value to write
		*
		@@ -284,6 +287,7 @@ int m5mols_write(struct v4l2_subdev *sd, u32 reg, u32 val)

		/**
		* m5mols_busy_wait - Busy waiting with I2C register polling
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @reg: the I2C_REG() address of an 8-bit status register to check
		* @value: expected status register value
		* @mask: bit mask for the read status register value
		@@ -316,6 +320,8 @@ int m5mols_busy_wait(struct v4l2_subdev *sd, u32 reg, u32 value, u32 mask,

		/**
		* m5mols_enable_interrupt - Clear interrupt pending bits and unmask interrupts
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @reg: combination of size, category and command for the I2C packet
		*
		* Before writing desired interrupt value the INT_FACTOR register should
		* be read to clear pending interrupts.
		@@ -349,6 +355,8 @@ int m5mols_wait_interrupt(struct v4l2_subdev *sd, u8 irq_mask, u32 timeout)

		/**
		* m5mols_reg_mode - Write the mode and check busy status
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @mode: the required operation mode
		*
		* It always accompanies a little delay changing the M-5MOLS mode, so it is
		* needed checking current busy status to guarantee right mode.
		@@ -364,6 +372,7 @@ static int m5mols_reg_mode(struct v4l2_subdev *sd, u8 mode)

		/**
		* m5mols_set_mode - set the M-5MOLS controller mode
		* @info: M-5MOLS driver data structure
		* @mode: the required operation mode
		*
		* The commands of M-5MOLS are grouped into specific modes. Each functionality
		@@ -421,6 +430,7 @@ int m5mols_set_mode(struct m5mols_info *info, u8 mode)

		/**
		* m5mols_get_version - retrieve full revisions information of M-5MOLS
		* @sd: sub-device, as pointed by struct v4l2_subdev
		*
		* The version information includes revisions of hardware and firmware,
		* AutoFocus alghorithm version and the version string.
		@@ -489,6 +499,7 @@ static enum m5mols_restype __find_restype(u32 code)

		/**
		* __find_resolution - Lookup preset and type of M-5MOLS's resolution
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @mf: pixel format to find/negotiate the resolution preset for
		* @type: M-5MOLS resolution type
		* @resolution: M-5MOLS resolution preset register value
		@@ -662,6 +673,7 @@ static const struct v4l2_subdev_pad_ops m5mols_pad_ops = {

		/**
		* m5mols_restore_controls - Apply current control values to the registers
		* @info: M-5MOLS driver data structure
		*
		* m5mols_do_scenemode() handles all parameters for which there is yet no
		* individual control. It should be replaced at some point by setting each
		@@ -686,6 +698,7 @@ int m5mols_restore_controls(struct m5mols_info *info)

		/**
		* m5mols_start_monitor - Start the monitor mode
		* @info: M-5MOLS driver data structure
		*
		* Before applying the controls setup the resolution and frame rate
		* in PARAMETER mode, and then switch over to MONITOR mode.
		@@ -789,6 +802,7 @@ int __attribute__ ((weak)) m5mols_update_fw(struct v4l2_subdev *sd,

		/**
		* m5mols_fw_start - M-5MOLS internal ARM controller initialization
		* @sd: sub-device, as pointed by struct v4l2_subdev
		*
		* Execute the M-5MOLS internal ARM controller initialization sequence.
		* This function should be called after the supply voltage has been
		@@ -844,6 +858,8 @@ static int m5mols_auto_focus_stop(struct m5mols_info *info)

		/**
		* m5mols_s_power - Main sensor power control function
		* @sd: sub-device, as pointed by struct v4l2_subdev
		* @on: if true, powers on the device; powers off otherwise.
		*
		* To prevent breaking the lens when the sensor is powered off the Soft-Landing
		* algorithm is called where available. The Soft-Landing algorithm availability

Admin message