Commit 13dd6094 authored by Even Xu's avatar Even Xu Committed by Jiri Kosina
Browse files

HID: Intel-thc-hid: Intel-thc: Refine code comments 



Align capitalization of the first characters for THC structure
definition comments in header files.

Signed-off-by: default avatarEven Xu <even.xu@intel.com>
Signed-off-by: default avatarJiri Kosina <jkosina@suse.com>
parent fccef495

drivers/hid/intel-thc-hid/intel-thc/intel-thc-dev.h

+8 −8
Original line number Diff line number Diff line
@@ -52,16 +52,16 @@ enum thc_int_type { 
 * struct thc_device - THC private device struct

 * @thc_regmap: MMIO regmap structure for accessing THC registers

 * @mmio_addr: MMIO registers address

 * @thc_bus_lock: mutex locker for THC config

 * @port_type: port type of THC port instance

 * @thc_bus_lock: Mutex locker for THC config

 * @port_type: Port type of THC port instance

 * @pio_int_supported: PIO interrupt supported flag

 * @dma_ctx: DMA specific data

 * @write_complete_wait: signal event for DMA write complete

 * @swdma_complete_wait: signal event for SWDMA sequence complete

 * @write_done: bool value that indicates if DMA write is done

 * @swdma_done: bool value that indicates if SWDMA swquence is done

 * @perf_limit: the delay between read operation and write operation

 * @i2c_subip_regs: the copy of THC I2C sub-system registers for resuming restore

 * @write_complete_wait: Signal event for DMA write complete

 * @swdma_complete_wait: Signal event for SWDMA sequence complete

 * @write_done: Bool value that indicates if DMA write is done

 * @swdma_done: Bool value that indicates if SWDMA sequence is done

 * @perf_limit: The delay between read operation and write operation

 * @i2c_subip_regs: The copy of THC I2C sub-system registers for resuming restore

 */

struct thc_device {

	struct device *dev;

drivers/hid/intel-thc-hid/intel-thc/intel-thc-dma.h

+12 −12
Original line number Diff line number Diff line
@@ -27,7 +27,7 @@ 


/**

 * THC DMA channels:

 * @THC_RXDMA1: legacy channel, reserved for raw data reading

 * @THC_RXDMA1: Legacy channel, reserved for raw data reading

 * @THC_RXDMA2: DMA to read HID data from touch device

 * @THC_TXDMA: DMA to write to touch device

 * @THC_SWDMA: SW triggered DMA to write and read from touch device
@@ -42,11 +42,11 @@ enum thc_dma_channel { 


/**

 * THC DMA Physical Memory Descriptor (PRD)

 * @dest_addr:		bit[53:0], destination address in system memory

 * @int_on_completion:	bit[63], if set, thc will trigger interrupt to driver

 * @len:		bit[87:64], length of this entry

 * @end_of_prd:		bit[88], if set, this entry is last one of current PRD table

 * @hw_status:		bit[90:89], hw status bits

 * @dest_addr:		Bit[53:0], destination address in system memory

 * @int_on_completion:	Bit[63], if set, thc will trigger interrupt to driver

 * @len:		Bit[87:64], length of this entry

 * @end_of_prd:		Bit[88], if set, this entry is last one of current PRD table

 * @hw_status:		Bit[90:89], hardware status bits

 */

struct thc_prd_entry {

	u64  dest_addr : 54;
@@ -88,14 +88,14 @@ struct thc_prd_table { 
 * struct thc_dma_configuration - THC DMA configure

 * @dma_channel: DMA channel for current DMA configuration

 * @prd_tbls_dma_handle: DMA buffer handle

 * @dir: direction of DMA for this config

 * @dir: Direction of DMA for this config

 * @prd_tbls: PRD tables for current DMA

 * @sgls: array of pointers to scatter-gather lists

 * @sgls_nent: actual number of entries per sg list

 * @prd_tbl_num: actual number of PRD tables

 * @max_packet_size: size of the buffer needed for 1 DMA message (1 PRD table)

 * @sgls: Array of pointers to scatter-gather lists

 * @sgls_nent: Actual number of entries per scatter-gather list

 * @prd_tbl_num: Actual number of PRD tables

 * @max_packet_size: Size of the buffer needed for 1 DMA message (1 PRD table)

 * @prd_base_addr_high: High 32bits memory address where stores PRD table

 * @prd_base_addr_low: low 32bits memory address where stores PRD table

 * @prd_base_addr_low: Low 32bits memory address where stores PRD table

 * @prd_cntrl: PRD control register value

 * @dma_cntrl: DMA control register value

 */