ralink/rt2x00/rt2x00queue.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 	Copyright (C) 2004 - 2010 Ivo van Doorn <IvDoorn@gmail.com>
21  * Ralink PCI devices demand the Frame size to be a multiple of 128 bytes,
23  * 2432 makes sense since it is big enough to contain the maximum fragment
24  * size according to the ieee802.11 specs.
42  * @QID_OTHER: None of the above (don't use, only present for completeness)
43  * @QID_BEACON: Beacon queue (value unspecified, don't send it to device)
44  * @QID_ATIM: Atim queue (value unspecified, don't send it to device)
63  * @SKBDESC_DMA_MAPPED_TX: &skb_dma field has been mapped for TX
67  *	don't try to pass it back.
87  * @tx_rate_idx: the index of the TX rate, used for TX status reporting
88  * @tx_rate_flags: the TX rate flags, used for TX status reporting
89  * @desc: Pointer to descriptor part of the frame.
90  *	Note that this pointer could point to something outside
91  *	of the scope of the skb->data pointer.
93  * @skb_dma: (PCI-only) the DMA address associated with the sk buffer.
112  * get_skb_frame_desc - Obtain the rt2x00 frame descriptor from a sk_buff.
119 	return (struct skb_frame_desc *)&IEEE80211_SKB_CB(skb)->driver_data;  in get_skb_frame_desc()
131  * @RXDONE_L2PAD: 802.11 payload has been padded to 4-byte boundary.
144  * RXDONE_SIGNAL_MASK - Define to mask off all &rxdone_entry_desc_flags flags
145  * except for the RXDONE_SIGNAL_* flags. This is useful to convert the dev_flags
146  * from &rxdone_entry_desc to a signal value type.
189  * Every txdone report has to contain the basic result of the
200  * @TXDONE_EXCESSIVE_RETRY: In addition to &TXDONE_FAILURE, the
201  *	frame transmission failed due to excessive retries.
214  * struct txdone_entry_desc: TX done entry descriptor
216  * Summary of information that has been read from the TX frame descriptor
219  * @flags: TX done flags (See &enum txdone_entry_desc_flags).
228  * enum txentry_desc_flags: Status flags for TX entry descriptor
231  * @ENTRY_TXD_CTS_FRAME: This frame is a CTS-to-self frame.
235  * @ENTRY_TXD_REQ_TIMESTAMP: Require timestamp to be inserted.
236  * @ENTRY_TXD_BURST: This frame belongs to the same burst event.
240  * @ENTRY_TXD_ENCRYPT_PAIRWISE: Use pairwise key table (instead of shared).
244  * @ENTRY_TXD_HT_BW_40: Use 40MHz Bandwidth.
245  * @ENTRY_TXD_HT_SHORT_GI: Use short GI.
269  * struct txentry_desc: TX Entry descriptor
271  * Summary of information for the frame descriptor before sending a TX frame.
281  * @stbc: Use Space Time Block Coding (only available for MCS rates < 8).
282  * @ba_size: Size of the recepients RX reorder buffer - 1.
331  * @ENTRY_BCN_ASSIGNED: This entry has been assigned to an interface.
335  *	transfer (either TX or RX depending on the queue). The entry should
338  *	for the signal to start sending.
340  *	while transferring the data to the hardware. No TX status report will
342  * @ENTRY_DATA_STATUS_PENDING: The entry has been send to the device and
360  * @queue: The data queue (&struct data_queue) to which this entry belongs.
361  * @skb: The buffer which is currently being transmitted (for TX queue),
362  *	or used to directly receive data in (for RX queue).
364  * @priv_data: Private data belonging to this queue entry. The pointer
365  *	points to data specific to a particular driver and queue type.
384  * @Q_INDEX: Index pointer to the current entry in the queue, if this entry is
385  *	owned by the hardware then the queue is considered to be full.
387  *	transferred to the hardware.
388  * @Q_INDEX_DONE: Index pointer to the next entry which will be completed by
389  *	the hardware and for which we need to run the txdone handler. If this
390  *	entry is not owned by the hardware the queue is considered to be empty.
391  * @Q_INDEX_MAX: Keep last, used in &struct data_queue to determine the size
402  * enum data_queue_flags: Status flags for data queues
404  * @QUEUE_STARTED: The queue has been started. Fox RX queues this means the
405  *	device might be DMA'ing skbuffers. TX queues will accept skbuffers to
406  *	be transmitted and beacon queues will start beaconing the configured
410  *	preventing new frames to be enqueued. However, a few frames
421  * @rt2x00dev: Pointer to main &struct rt2x00dev where this queue belongs to.
428  * @tx_lock: Spinlock to serialize tx operations on this queue.
429  * @index_lock: Spinlock to protect index handling. Whenever @index, @index_done or
430  *	@index_crypt needs to be changed this lock should be grabbed to prevent
431  *	index corruption due to concurrency.
436  * @index: Index pointers to entry positions in the queue,
437  *	use &enum queue_index to get a specific index field.
447  * @priv_size: Size of per-queue_entry private data.
486  * queue_end - Return pointer to the last queue (HELPER MACRO).
487  * @__dev: Pointer to &struct rt2x00_dev
489  * Using the base rx pointer and the maximum number of available queues,
491  * queues array.
494 	&(__dev)->rx[(__dev)->data_queues]
497  * tx_queue_end - Return pointer to the last TX queue (HELPER MACRO).
498  * @__dev: Pointer to &struct rt2x00_dev
500  * Using the base tx pointer and the maximum number of available TX
501  * queues, this macro will return the address of 1 position beyond
502  * the end of the TX queue array.
505 	&(__dev)->tx[(__dev)->ops->tx_queues]
508  * queue_next - Return pointer to next queue in list (HELPER MACRO).
512  * after the queue to take the next queue. Note that this macro
521  * queue_loop - Loop through the queues within a specific range (HELPER MACRO).
526  * This macro will loop through all queues between &__start and &__end.
534  * queue_for_each - Loop through all queues
535  * @__dev: Pointer to &struct rt2x00_dev
538  * This macro will loop through all available queues.
541 	queue_loop(__entry, (__dev)->rx, queue_end(__dev))
544  * tx_queue_for_each - Loop through the TX queues
545  * @__dev: Pointer to &struct rt2x00_dev
548  * This macro will loop through all TX related queues excluding
549  * the Beacon and Atim queues.
552 	queue_loop(__entry, (__dev)->tx, tx_queue_end(__dev))
555  * txall_queue_for_each - Loop through all TX related queues
556  * @__dev: Pointer to &struct rt2x00_dev
559  * This macro will loop through all TX related queues including
560  * the Beacon and Atim queues.
563 	queue_loop(__entry, (__dev)->tx, queue_end(__dev))
566  * rt2x00queue_for_each_entry - Loop through all entries in the queue
567  * @queue: Pointer to @data_queue
568  * @start: &enum queue_index Pointer to start index
569  * @end: &enum queue_index Pointer to end index
570  * @data: Data to pass to the callback function
571  * @fn: The function to call for each &struct queue_entry
588  * rt2x00queue_empty - Check if the queue is empty.
589  * @queue: Queue to check if empty.
593 	return queue->length == 0;  in rt2x00queue_empty()
597  * rt2x00queue_full - Check if the queue is full.
598  * @queue: Queue to check if full.
602 	return queue->length == queue->limit;  in rt2x00queue_full()
606  * rt2x00queue_free - Check the number of available entries in queue.
607  * @queue: Queue to check.
611 	return queue->limit - queue->length;  in rt2x00queue_available()
615  * rt2x00queue_threshold - Check if the queue is below threshold
616  * @queue: Queue to check.
620 	return rt2x00queue_available(queue) < queue->threshold;  in rt2x00queue_threshold()
623  * rt2x00queue_dma_timeout - Check if a timeout occurred for DMA transfers
624  * @entry: Queue entry to check.
628 	if (!test_bit(ENTRY_OWNER_DEVICE_DATA, &entry->flags))  in rt2x00queue_dma_timeout()
630 	return time_after(jiffies, entry->last_action + msecs_to_jiffies(100));  in rt2x00queue_dma_timeout()
634  * _rt2x00_desc_read - Read a word from the hardware descriptor.
644  * rt2x00_desc_read - Read a word from the hardware descriptor, this
655  * rt2x00_desc_write - write a word to the hardware descriptor, this
667  * rt2x00_desc_write - write a word to the hardware descriptor.