Commit ea6bb47f authored by Alan Borzeszkowski's avatar Alan Borzeszkowski Committed by Mika Westerberg
Browse files

thunderbolt: Update thunderbolt.h header file 



Make Thunderbolt header file compliant with current kernel-doc
standards. No functional changes.

Signed-off-by: default avatarAlan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: default avatarMika Westerberg <mika.westerberg@linux.intel.com>
parent 81a1962c

include/linux/thunderbolt.h

+14 −11
Original line number Diff line number Diff line
@@ -213,7 +213,7 @@ enum tb_link_width { 
 *		queried first

 * @service_ids: Used to generate IDs for the services

 * @in_hopids: Input HopIDs for DMA tunneling

 * @out_hopids; Output HopIDs for DMA tunneling

 * @out_hopids: Output HopIDs for DMA tunneling

 * @local_property_block: Local block of properties

 * @local_property_block_gen: Generation of @local_property_block

 * @local_property_block_len: Length of the @local_property_block in dwords
@@ -356,7 +356,7 @@ int tb_xdomain_request(struct tb_xdomain *xd, const void *request, 
		       unsigned int timeout_msec);



/**

 * tb_protocol_handler - Protocol specific handler

 * struct tb_protocol_handler - Protocol specific handler

 * @uuid: XDomain messages with this UUID are dispatched to this handler

 * @callback: Callback called with the XDomain message. Returning %1

 *	      here tells the XDomain core that the message was handled
@@ -437,7 +437,7 @@ static inline struct tb_service *tb_to_service(struct device *dev) 
}



/**

 * tb_service_driver - Thunderbolt service driver

 * struct tb_service_driver - Thunderbolt service driver

 * @driver: Driver structure

 * @probe: Called when the driver is probed

 * @remove: Called when the driver is removed (optional)
@@ -519,6 +519,7 @@ struct tb_nhi { 
 * @head: Head of the ring (write next descriptor here)

 * @tail: Tail of the ring (complete next descriptor here)

 * @descriptors: Allocated descriptors for this ring

 * @descriptors_dma: DMA address of descriptors for this ring

 * @queue: Queue holding frames to be transferred over this ring

 * @in_flight: Queue holding frames that are currently in flight

 * @work: Interrupt work structure
@@ -571,12 +572,12 @@ typedef void (*ring_cb)(struct tb_ring *, struct ring_frame *, bool canceled); 


/**

 * enum ring_desc_flags - Flags for DMA ring descriptor

 * %RING_DESC_ISOCH: Enable isonchronous DMA (Tx only)

 * %RING_DESC_CRC_ERROR: In frame mode CRC check failed for the frame (Rx only)

 * %RING_DESC_COMPLETED: Descriptor completed (set by NHI)

 * %RING_DESC_POSTED: Always set this

 * %RING_DESC_BUFFER_OVERRUN: RX buffer overrun

 * %RING_DESC_INTERRUPT: Request an interrupt on completion

 * @RING_DESC_ISOCH: Enable isonchronous DMA (Tx only)

 * @RING_DESC_CRC_ERROR: In frame mode CRC check failed for the frame (Rx only)

 * @RING_DESC_COMPLETED: Descriptor completed (set by NHI)

 * @RING_DESC_POSTED: Always set this

 * @RING_DESC_BUFFER_OVERRUN: RX buffer overrun

 * @RING_DESC_INTERRUPT: Request an interrupt on completion

 */

enum ring_desc_flags {

	RING_DESC_ISOCH = 0x1,
@@ -636,7 +637,7 @@ int __tb_ring_enqueue(struct tb_ring *ring, struct ring_frame *frame); 
 * If ring_stop() is called after the packet has been enqueued

 * @frame->callback will be called with canceled set to true.

 *

 * Return: Returns %-ESHUTDOWN if ring_stop has been called. Zero otherwise.

 * Return: %-ESHUTDOWN if ring_stop() has been called, %0 otherwise.

 */

static inline int tb_ring_rx(struct tb_ring *ring, struct ring_frame *frame)

{
@@ -657,7 +658,7 @@ static inline int tb_ring_rx(struct tb_ring *ring, struct ring_frame *frame) 
 * If ring_stop() is called after the packet has been enqueued @frame->callback

 * will be called with canceled set to true.

 *

 * Return: Returns %-ESHUTDOWN if ring_stop has been called. Zero otherwise.

 * Return: %-ESHUTDOWN if ring_stop has been called, %0 otherwise.

 */

static inline int tb_ring_tx(struct tb_ring *ring, struct ring_frame *frame)

{
@@ -675,6 +676,8 @@ void tb_ring_poll_complete(struct tb_ring *ring); 
 *

 * Use this function when you are mapping DMA for buffers that are

 * passed to the ring for sending/receiving.

 *

 * Return: Pointer to device used for DMA mapping.

 */

static inline struct device *tb_ring_dma_device(struct tb_ring *ring)

{