tty: Update some of the USB kernel doc
Updates some usb_serial_port members documentation. Signed-off-by: Leandro Dorileo <ldorileo@gmail.com> Signed-off-by: Alan Cox <alan@lxorguk.ukuu.org.uk> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
		
					parent
					
						
							
								19e0542620
							
						
					
				
			
			
				commit
				
					
						78c5b82ee6
					
				
			
		
					 1 changed files with 5 additions and 2 deletions
				
			
		| 
						 | 
					@ -29,7 +29,7 @@
 | 
				
			||||||
/**
 | 
					/**
 | 
				
			||||||
 * usb_serial_port: structure for the specific ports of a device.
 | 
					 * usb_serial_port: structure for the specific ports of a device.
 | 
				
			||||||
 * @serial: pointer back to the struct usb_serial owner of this port.
 | 
					 * @serial: pointer back to the struct usb_serial owner of this port.
 | 
				
			||||||
 * @tty: pointer to the corresponding tty for this port.
 | 
					 * @port: pointer to the corresponding tty_port for this port.
 | 
				
			||||||
 * @lock: spinlock to grab when updating portions of this structure.
 | 
					 * @lock: spinlock to grab when updating portions of this structure.
 | 
				
			||||||
 * @mutex: mutex used to synchronize serial_open() and serial_close()
 | 
					 * @mutex: mutex used to synchronize serial_open() and serial_close()
 | 
				
			||||||
 *	access for this port.
 | 
					 *	access for this port.
 | 
				
			||||||
| 
						 | 
					@ -44,19 +44,22 @@
 | 
				
			||||||
 * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
 | 
					 * @interrupt_out_endpointAddress: endpoint address for the interrupt out pipe
 | 
				
			||||||
 * 	for this port.
 | 
					 * 	for this port.
 | 
				
			||||||
 * @bulk_in_buffer: pointer to the bulk in buffer for this port.
 | 
					 * @bulk_in_buffer: pointer to the bulk in buffer for this port.
 | 
				
			||||||
 | 
					 * @bulk_in_size: the size of the bulk_in_buffer, in bytes.
 | 
				
			||||||
 * @read_urb: pointer to the bulk in struct urb for this port.
 | 
					 * @read_urb: pointer to the bulk in struct urb for this port.
 | 
				
			||||||
 * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
 | 
					 * @bulk_in_endpointAddress: endpoint address for the bulk in pipe for this
 | 
				
			||||||
 *	port.
 | 
					 *	port.
 | 
				
			||||||
 * @bulk_out_buffer: pointer to the bulk out buffer for this port.
 | 
					 * @bulk_out_buffer: pointer to the bulk out buffer for this port.
 | 
				
			||||||
 * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
 | 
					 * @bulk_out_size: the size of the bulk_out_buffer, in bytes.
 | 
				
			||||||
 * @write_urb: pointer to the bulk out struct urb for this port.
 | 
					 * @write_urb: pointer to the bulk out struct urb for this port.
 | 
				
			||||||
 | 
					 * @write_urb_busy: port`s writing status
 | 
				
			||||||
 * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
 | 
					 * @bulk_out_endpointAddress: endpoint address for the bulk out pipe for this
 | 
				
			||||||
 *	port.
 | 
					 *	port.
 | 
				
			||||||
 * @write_wait: a wait_queue_head_t used by the port.
 | 
					 * @write_wait: a wait_queue_head_t used by the port.
 | 
				
			||||||
 * @work: work queue entry for the line discipline waking up.
 | 
					 * @work: work queue entry for the line discipline waking up.
 | 
				
			||||||
 * @open_count: number of times this port has been opened.
 | 
					 | 
				
			||||||
 * @throttled: nonzero if the read urb is inactive to throttle the device
 | 
					 * @throttled: nonzero if the read urb is inactive to throttle the device
 | 
				
			||||||
 * @throttle_req: nonzero if the tty wants to throttle us
 | 
					 * @throttle_req: nonzero if the tty wants to throttle us
 | 
				
			||||||
 | 
					 * @console: attached usb serial console
 | 
				
			||||||
 | 
					 * @dev: pointer to the serial device
 | 
				
			||||||
 *
 | 
					 *
 | 
				
			||||||
 * This structure is used by the usb-serial core and drivers for the specific
 | 
					 * This structure is used by the usb-serial core and drivers for the specific
 | 
				
			||||||
 * ports of a device.
 | 
					 * ports of a device.
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue