Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
thunderbolt: Update thunderbolt.h header file
Make Thunderbolt header file compliant with current kernel-doc
standards. No functional changes.
Signed-off-by: Alan Borzeszkowski <alan.borzeszkowski@linux.intel.com>
Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
authored by
Alan Borzeszkowski
and committed by
Mika Westerberg
ea6bb47f
81a1962c
+14
-11
+14
-11
include/linux/thunderbolt.h
+14
-11
include/linux/thunderbolt.h
···
213
213
* queried first
214
214
* @service_ids: Used to generate IDs for the services
215
215
* @in_hopids: Input HopIDs for DMA tunneling
216
-
* @out_hopids; Output HopIDs for DMA tunneling
216
+
* @out_hopids: Output HopIDs for DMA tunneling
217
217
* @local_property_block: Local block of properties
218
218
* @local_property_block_gen: Generation of @local_property_block
219
219
* @local_property_block_len: Length of the @local_property_block in dwords
···
356
356
unsigned int timeout_msec);
357
357
358
358
/**
359
-
* tb_protocol_handler - Protocol specific handler
359
+
* struct tb_protocol_handler - Protocol specific handler
360
360
* @uuid: XDomain messages with this UUID are dispatched to this handler
361
361
* @callback: Callback called with the XDomain message. Returning %1
362
362
* here tells the XDomain core that the message was handled
···
437
437
}
438
438
439
439
/**
440
-
* tb_service_driver - Thunderbolt service driver
440
+
* struct tb_service_driver - Thunderbolt service driver
441
441
* @driver: Driver structure
442
442
* @probe: Called when the driver is probed
443
443
* @remove: Called when the driver is removed (optional)
···
519
519
* @head: Head of the ring (write next descriptor here)
520
520
* @tail: Tail of the ring (complete next descriptor here)
521
521
* @descriptors: Allocated descriptors for this ring
522
+
* @descriptors_dma: DMA address of descriptors for this ring
522
523
* @queue: Queue holding frames to be transferred over this ring
523
524
* @in_flight: Queue holding frames that are currently in flight
524
525
* @work: Interrupt work structure
···
572
571
573
572
/**
574
573
* enum ring_desc_flags - Flags for DMA ring descriptor
575
-
* %RING_DESC_ISOCH: Enable isonchronous DMA (Tx only)
576
-
* %RING_DESC_CRC_ERROR: In frame mode CRC check failed for the frame (Rx only)
577
-
* %RING_DESC_COMPLETED: Descriptor completed (set by NHI)
578
-
* %RING_DESC_POSTED: Always set this
579
-
* %RING_DESC_BUFFER_OVERRUN: RX buffer overrun
580
-
* %RING_DESC_INTERRUPT: Request an interrupt on completion
574
+
* @RING_DESC_ISOCH: Enable isonchronous DMA (Tx only)
575
+
* @RING_DESC_CRC_ERROR: In frame mode CRC check failed for the frame (Rx only)
576
+
* @RING_DESC_COMPLETED: Descriptor completed (set by NHI)
577
+
* @RING_DESC_POSTED: Always set this
578
+
* @RING_DESC_BUFFER_OVERRUN: RX buffer overrun
579
+
* @RING_DESC_INTERRUPT: Request an interrupt on completion
581
580
*/
582
581
enum ring_desc_flags {
583
582
RING_DESC_ISOCH = 0x1,
···
637
636
* If ring_stop() is called after the packet has been enqueued
638
637
* @frame->callback will be called with canceled set to true.
639
638
*
640
-
* Return: Returns %-ESHUTDOWN if ring_stop has been called. Zero otherwise.
639
+
* Return: %-ESHUTDOWN if ring_stop() has been called, %0 otherwise.
641
640
*/
642
641
static inline int tb_ring_rx(struct tb_ring *ring, struct ring_frame *frame)
643
642
{
···
658
657
* If ring_stop() is called after the packet has been enqueued @frame->callback
659
658
* will be called with canceled set to true.
660
659
*
661
-
* Return: Returns %-ESHUTDOWN if ring_stop has been called. Zero otherwise.
660
+
* Return: %-ESHUTDOWN if ring_stop has been called, %0 otherwise.
662
661
*/
663
662
static inline int tb_ring_tx(struct tb_ring *ring, struct ring_frame *frame)
664
663
{
···
676
675
*
677
676
* Use this function when you are mapping DMA for buffers that are
678
677
* passed to the ring for sending/receiving.
678
+
*
679
+
* Return: Pointer to device used for DMA mapping.
679
680
*/
680
681
static inline struct device *tb_ring_dma_device(struct tb_ring *ring)
681
682
{