ath10k: fix comments style in rx_desc.h file
PATCH 1/1 ath10k: fix comments style in rx_desc.h file
Signed-off-by Bartosz Markowski <[email protected]>
--- drivers/net/wireless/ath/ath10k/rx_desc.h | 1360 ++++++++++++++--------------- 1 file changed, 680 insertions(+), 680 deletions(-)
drivers/net/wireless/ath/ath10k/rx_desc.h +680 -680
@@ -58,152 +58,152 @@ struct rx_attention { } __packed;/* -first_mpdu -Indicates the first MSDU of the PPDU. If both first_mpdu -and last_mpdu are set in the MSDU then this is a not an -A-MPDU frame but a stand alone MPDU. Interior MPDU in an -A-MPDU shall have both first_mpdu and last_mpdu bits set to -0. The PPDU start status will only be valid when this bit -is set. - -last_mpdu -Indicates the last MSDU of the last MPDU of the PPDU. The -PPDU end status will only be valid when this bit is set. - -mcast_bcast -Multicast / broadcast indicator. Only set when the MAC -address 1 bit 0 is set indicating mcast/bcast and the BSSID -matches one of the 4 BSSID registers. Only set when -first_msdu is set. - -peer_idx_invalid -Indicates no matching entries within the the max search -count. Only set when first_msdu is set. - -peer_idx_timeout -Indicates an unsuccessful search for the peer index due to -timeout. Only set when first_msdu is set. - -power_mgmt -Power management bit set in the 802.11 header. Only set -when first_msdu is set. - -non_qos -Set if packet is not a non-QoS data frame. Only set when -first_msdu is set. - -null_data -Set if frame type indicates either null data or QoS null -data format. Only set when first_msdu is set. - -mgmt_type -Set if packet is a management packet. Only set when -first_msdu is set. - -ctrl_type -Set if packet is a control packet. Only set when first_msdu -is set. - -more_data -Set if more bit in frame control is set. Only set when -first_msdu is set. - -eosp -Set if the EOSP (end of service period) bit in the QoS -control field is set. Only set when first_msdu is set. - -u_apsd_trigger -Set if packet is U-APSD trigger. Key table will have bits -per TID to indicate U-APSD trigger. - -fragment -Indicates that this is an 802.11 fragment frame. This is -set when either the more_frag bit is set in the frame -control or the fragment number is not zero. Only set when -first_msdu is set. - -order -Set if the order bit in the frame control is set. Only set -when first_msdu is set. - -classification -Indicates that this status has a corresponding MSDU that -requires FW processing. The OLE will have classification -ring mask registers which will indicate the ring(s) for -packets and descriptors which need FW attention. - -overflow_err -PCU Receive FIFO does not have enough space to store the -full receive packet. Enough space is reserved in the -receive FIFO for the status is written. This MPDU remaining -packets in the PPDU will be filtered and no Ack response -will be transmitted. - -msdu_length_err -Indicates that the MSDU length from the 802.3 encapsulated -length field extends beyond the MPDU boundary. - -tcp_udp_chksum_fail -Indicates that the computed checksum (tcp_udp_chksum) did -not match the checksum in the TCP/UDP header. - -ip_chksum_fail -Indicates that the computed checksum did not match the -checksum in the IP header. - -sa_idx_invalid -Indicates no matching entry was found in the address search -table for the source MAC address. - -da_idx_invalid -Indicates no matching entry was found in the address search -table for the destination MAC address. - -sa_idx_timeout -Indicates an unsuccessful search for the source MAC address -due to the expiring of the search timer. - -da_idx_timeout -Indicates an unsuccessful search for the destination MAC -address due to the expiring of the search timer. - -encrypt_required -Indicates that this data type frame is not encrypted even if -the policy for this MPDU requires encryption as indicated in -the peer table key type. - -directed -MPDU is a directed packet which means that the RA matched -our STA addresses. In proxySTA it means that the TA matched -an entry in our address search table with the corresponding -'no_ack' bit is the address search entry cleared. - -buffer_fragment -Indicates that at least one of the rx buffers has been -fragmented. If set the FW should look at the rx_frag_info -descriptor described below. - -mpdu_length_err -Indicates that the MPDU was pre-maturely terminated -resulting in a truncated MPDU. Don't trust the MPDU length -field. - -tkip_mic_err -Indicates that the MPDU Michael integrity check failed - -decrypt_err -Indicates that the MPDU decrypt integrity check failed - -fcs_err -Indicates that the MPDU FCS check failed - -msdu_done -If set indicates that the RX packet data, RX header data, RX -PPDU start descriptor, RX MPDU start/end descriptor, RX MSDU -start/end descriptors and RX Attention descriptor are all -valid. This bit must be in the last octet of the -descriptor. -*/ +* first_mpdu +* Indicates the first MSDU of the PPDU. If both first_mpdu +* and last_mpdu are set in the MSDU then this is a not an +* A-MPDU frame but a stand alone MPDU. Interior MPDU in an +* A-MPDU shall have both first_mpdu and last_mpdu bits set to +* 0. The PPDU start status will only be valid when this bit +* is set. +* +* last_mpdu +* Indicates the last MSDU of the last MPDU of the PPDU. The +* PPDU end status will only be valid when this bit is set. +* +* mcast_bcast +* Multicast / broadcast indicator. Only set when the MAC +* address 1 bit 0 is set indicating mcast/bcast and the BSSID +* matches one of the 4 BSSID registers. Only set when +* first_msdu is set. +* +* peer_idx_invalid +* Indicates no matching entries within the the max search +* count. Only set when first_msdu is set. +* +* peer_idx_timeout +* Indicates an unsuccessful search for the peer index due to +* timeout. Only set when first_msdu is set. +* +* power_mgmt +* Power management bit set in the 802.11 header. Only set +* when first_msdu is set. +* +* non_qos +* Set if packet is not a non-QoS data frame. Only set when +* first_msdu is set. +* +* null_data +* Set if frame type indicates either null data or QoS null +* data format. Only set when first_msdu is set. +* +* mgmt_type +* Set if packet is a management packet. Only set when +* first_msdu is set. +* +* ctrl_type +* Set if packet is a control packet. Only set when first_msdu +* is set. +* +* more_data +* Set if more bit in frame control is set. Only set when +* first_msdu is set. +* +* eosp +* Set if the EOSP (end of service period) bit in the QoS +* control field is set. Only set when first_msdu is set. +* +* u_apsd_trigger +* Set if packet is U-APSD trigger. Key table will have bits +* per TID to indicate U-APSD trigger. +* +* fragment +* Indicates that this is an 802.11 fragment frame. This is +* set when either the more_frag bit is set in the frame +* control or the fragment number is not zero. Only set when +* first_msdu is set. +* +* order +* Set if the order bit in the frame control is set. Only set +* when first_msdu is set. +* +* classification +* Indicates that this status has a corresponding MSDU that +* requires FW processing. The OLE will have classification +* ring mask registers which will indicate the ring(s) for +* packets and descriptors which need FW attention. +* +* overflow_err +* PCU Receive FIFO does not have enough space to store the +* full receive packet. Enough space is reserved in the +* receive FIFO for the status is written. This MPDU remaining +* packets in the PPDU will be filtered and no Ack response +* will be transmitted. +* +* msdu_length_err +* Indicates that the MSDU length from the 802.3 encapsulated +* length field extends beyond the MPDU boundary. +* +* tcp_udp_chksum_fail +* Indicates that the computed checksum (tcp_udp_chksum) did +* not match the checksum in the TCP/UDP header. +* +* ip_chksum_fail +* Indicates that the computed checksum did not match the +* checksum in the IP header. +* +* sa_idx_invalid +* Indicates no matching entry was found in the address search +* table for the source MAC address. +* +* da_idx_invalid +* Indicates no matching entry was found in the address search +* table for the destination MAC address. +* +* sa_idx_timeout +* Indicates an unsuccessful search for the source MAC address +* due to the expiring of the search timer. +* +* da_idx_timeout +* Indicates an unsuccessful search for the destination MAC +* address due to the expiring of the search timer. +* +* encrypt_required +* Indicates that this data type frame is not encrypted even if +* the policy for this MPDU requires encryption as indicated in +* the peer table key type. +* +* directed +* MPDU is a directed packet which means that the RA matched +* our STA addresses. In proxySTA it means that the TA matched +* an entry in our address search table with the corresponding +* 'no_ack' bit is the address search entry cleared. +* +* buffer_fragment +* Indicates that at least one of the rx buffers has been +* fragmented. If set the FW should look at the rx_frag_info +* descriptor described below. +* +* mpdu_length_err +* Indicates that the MPDU was pre-maturely terminated +* resulting in a truncated MPDU. Don't trust the MPDU length +* field. +* +* tkip_mic_err +* Indicates that the MPDU Michael integrity check failed +* +* decrypt_err +* Indicates that the MPDU decrypt integrity check failed +* +* fcs_err +* Indicates that the MPDU FCS check failed +* +* msdu_done +* If set indicates that the RX packet data, RX header data, RX +* PPDU start descriptor, RX MPDU start/end descriptor, RX MSDU +* start/end descriptors and RX Attention descriptor are all +* valid. This bit must be in the last octet of the +* descriptor. +*/ struct rx_frag_info {u8 ring0_more_count;
@@ -213,22 +213,22 @@ struct rx_frag_info { } __packed;/* -ring0_more_count -Indicates the number of more buffers associated with RX DMA -ring 0. Field is filled in by the RX_DMA. - -ring1_more_count -Indicates the number of more buffers associated with RX DMA -ring 1. Field is filled in by the RX_DMA. - -ring2_more_count -Indicates the number of more buffers associated with RX DMA -ring 2. Field is filled in by the RX_DMA. - -ring3_more_count -Indicates the number of more buffers associated with RX DMA -ring 3. Field is filled in by the RX_DMA. -*/ +* ring0_more_count +* Indicates the number of more buffers associated with RX DMA +* ring 0. Field is filled in by the RX_DMA. +* +* ring1_more_count +* Indicates the number of more buffers associated with RX DMA +* ring 1. Field is filled in by the RX_DMA. +* +* ring2_more_count +* Indicates the number of more buffers associated with RX DMA +* ring 2. Field is filled in by the RX_DMA. +* +* ring3_more_count +* Indicates the number of more buffers associated with RX DMA +* ring 3. Field is filled in by the RX_DMA. +*/ enum htt_rx_mpdu_encrypt_type {HTT_RX_MPDU_ENCRYPT_WEP40 =0 ,
@@ -271,80 +271,80 @@ struct rx_mpdu_start { } __packed;/* -peer_idx -The index of the address search table which associated with -the peer table entry corresponding to this MPDU. Only valid -when first_msdu is set. - -fr_ds -Set if the from DS bit is set in the frame control. Only -valid when first_msdu is set. - -to_ds -Set if the to DS bit is set in the frame control. Only -valid when first_msdu is set. - -encrypted -Protected bit from the frame control. Only valid when -first_msdu is set. - -retry -Retry bit from the frame control. Only valid when -first_msdu is set. - -txbf_h_info -The MPDU data will contain H information. Primarily used -for debug. - -seq_num -The sequence number from the 802.11 header. Only valid when -first_msdu is set. - -encrypt_type -Indicates type of decrypt cipher used (as defined in the -peer table) -0: WEP40 -1: WEP104 -2: TKIP without MIC -3: WEP128 -4: TKIP (WPA) -5: WAPI -6: AES-CCM (WPA2) -7: No cipher -Only valid when first_msdu_is set - -pn_31_0 -Bits [31:0] of the PN number extracted from the IV field -WEP: IV = {key_id_octet, pn2, pn1, pn0}. Only pn[23:0] is -valid. -TKIP: IV = {pn5, pn4, pn3, pn2, key_id_octet, pn0, -WEPSeed[1], pn1}. Only pn[47:0] is valid. -AES-CCM: IV = {pn5, pn4, pn3, pn2, key_id_octet, 0x0, pn1, -pn0}. Only pn[47:0] is valid. -WAPI: IV = {key_id_octet, 0x0, pn15, pn14, pn13, pn12, pn11, -pn10, pn9, pn8, pn7, pn6, pn5, pn4, pn3, pn2, pn1, pn0}. -The ext_wapi_pn[127:48] in the rx_msdu_misc descriptor and -pn[47:0] are valid. -Only valid when first_msdu is set. - -pn_47_32 -Bits [47:32] of the PN number. See description for -pn_31_0. The remaining PN fields are in the rx_msdu_end -descriptor - -pn -Use this field to access the pn without worrying about -byte-order and bitmasking/bitshifting. - -directed -See definition in RX attention descriptor - -reserved_2 -Reserved: HW should fill with zero. FW should ignore. - -tid -The TID field in the QoS control field -*/ +* peer_idx +* The index of the address search table which associated with +* the peer table entry corresponding to this MPDU. Only valid +* when first_msdu is set. +* +* fr_ds +* Set if the from DS bit is set in the frame control. Only +* valid when first_msdu is set. +* +* to_ds +* Set if the to DS bit is set in the frame control. Only +* valid when first_msdu is set. +* +* encrypted +* Protected bit from the frame control. Only valid when +* first_msdu is set. +* +* retry +* Retry bit from the frame control. Only valid when +* first_msdu is set. +* +* txbf_h_info +* The MPDU data will contain H information. Primarily used +* for debug. +* +* seq_num +* The sequence number from the 802.11 header. Only valid when +* first_msdu is set. +* +* encrypt_type +* Indicates type of decrypt cipher used (as defined in the +* peer table) +* 0: WEP40 +* 1: WEP104 +* 2: TKIP without MIC +* 3: WEP128 +* 4: TKIP (WPA) +* 5: WAPI +* 6: AES-CCM (WPA2) +* 7: No cipher +* Only valid when first_msdu_is set +* +* pn_31_0 +* Bits [31:0] of the PN number extracted from the IV field +* WEP: IV = {key_id_octet, pn2, pn1, pn0}. Only pn[23:0] is +* valid. +* TKIP: IV = {pn5, pn4, pn3, pn2, key_id_octet, pn0, +* WEPSeed[1], pn1}. Only pn[47:0] is valid. +* AES-CCM: IV = {pn5, pn4, pn3, pn2, key_id_octet, 0x0, pn1, +* pn0}. Only pn[47:0] is valid. +* WAPI: IV = {key_id_octet, 0x0, pn15, pn14, pn13, pn12, pn11, +* pn10, pn9, pn8, pn7, pn6, pn5, pn4, pn3, pn2, pn1, pn0}. +* The ext_wapi_pn[127:48] in the rx_msdu_misc descriptor and +* pn[47:0] are valid. +* Only valid when first_msdu is set. +* +* pn_47_32 +* Bits [47:32] of the PN number. See description for +* pn_31_0. The remaining PN fields are in the rx_msdu_end +* descriptor +* +* pn +* Use this field to access the pn without worrying about +* byte-order and bitmasking/bitshifting. +* +* directed +* See definition in RX attention descriptor +* +* reserved_2 +* Reserved: HW should fill with zero. FW should ignore. +* +* tid +* The TID field in the QoS control field +*/ #define RX_MPDU_END_INFO0_RESERVED_0_MASK 0x00001fff#define RX_MPDU_END_INFO0_RESERVED_0_LSB 0
@@ -363,42 +363,42 @@ struct rx_mpdu_end { } __packed;/* -reserved_0 -Reserved - -overflow_err -PCU Receive FIFO does not have enough space to store the -full receive packet. Enough space is reserved in the -receive FIFO for the status is written. This MPDU remaining -packets in the PPDU will be filtered and no Ack response -will be transmitted. - -last_mpdu -Indicates that this is the last MPDU of a PPDU. - -post_delim_err -Indicates that a delimiter FCS error occurred after this -MPDU before the next MPDU. Only valid when last_msdu is -set. - -post_delim_cnt -Count of the delimiters after this MPDU. This requires the -last MPDU to be held until all the EOF descriptors have been -received. This may be inefficient in the future when -ML-MIMO is used. Only valid when last_mpdu is set. - -mpdu_length_err -See definition in RX attention descriptor - -tkip_mic_err -See definition in RX attention descriptor - -decrypt_err -See definition in RX attention descriptor - -fcs_err -See definition in RX attention descriptor -*/ +* reserved_0 +* Reserved +* +* overflow_err +* PCU Receive FIFO does not have enough space to store the +* full receive packet. Enough space is reserved in the +* receive FIFO for the status is written. This MPDU remaining +* packets in the PPDU will be filtered and no Ack response +* will be transmitted. +* +* last_mpdu +* Indicates that this is the last MPDU of a PPDU. +* +* post_delim_err +* Indicates that a delimiter FCS error occurred after this +* MPDU before the next MPDU. Only valid when last_msdu is +* set. +* +* post_delim_cnt +* Count of the delimiters after this MPDU. This requires the +* last MPDU to be held until all the EOF descriptors have been +* received. This may be inefficient in the future when +* ML-MIMO is used. Only valid when last_mpdu is set. +* +* mpdu_length_err +* See definition in RX attention descriptor +* +* tkip_mic_err +* See definition in RX attention descriptor +* +* decrypt_err +* See definition in RX attention descriptor +* +* fcs_err +* See definition in RX attention descriptor +*/ #define RX_MSDU_START_INFO0_MSDU_LENGTH_MASK 0x00003fff#define RX_MSDU_START_INFO0_MSDU_LENGTH_LSB 0
@@ -436,82 +436,82 @@ struct rx_msdu_start { } __packed;/* -msdu_length -MSDU length in bytes after decapsulation. This field is -still valid for MPDU frames without A-MSDU. It still -represents MSDU length after decapsulation - -ip_offset -Indicates the IP offset in bytes from the start of the -packet after decapsulation. Only valid if ipv4_proto or -ipv6_proto is set. - -ring_mask -Indicates the destination RX rings for this MSDU. - -tcp_udp_offset -Indicates the offset in bytes to the start of TCP or UDP -header from the start of the IP header after decapsulation. -Only valid if tcp_prot or udp_prot is set. The value 0 -indicates that the offset is longer than 127 bytes. - -reserved_0c -Reserved: HW should fill with zero. FW should ignore. - -flow_id_crc -The flow_id_crc runs CRC32 on the following information: -IPv4 option: dest_addr[31:0], src_addr [31:0], {24'b0, -protocol[7:0]}. -IPv6 option: dest_addr[127:0], src_addr [127:0], {24'b0, -next_header[7:0]} -UDP case: sort_port[15:0], dest_port[15:0] -TCP case: sort_port[15:0], dest_port[15:0], -{header_length[3:0], 6'b0, flags[5:0], window_size[15:0]}, -{16'b0, urgent_ptr[15:0]}, all options except 32-bit -timestamp. - -msdu_number -Indicates the MSDU number within a MPDU. This value is -reset to zero at the start of each MPDU. If the number of -MSDU exceeds 255 this number will wrap using modulo 256. - -decap_format -Indicates the format after decapsulation: -0: RAW: No decapsulation -1: Native WiFi -2: Ethernet 2 (DIX) -3: 802.3 (SNAP/LLC) - -ipv4_proto -Set if L2 layer indicates IPv4 protocol. - -ipv6_proto -Set if L2 layer indicates IPv6 protocol. - -tcp_proto -Set if the ipv4_proto or ipv6_proto are set and the IP -protocol indicates TCP. - -udp_proto -Set if the ipv4_proto or ipv6_proto are set and the IP -protocol indicates UDP. - -ip_frag -Indicates that either the IP More frag bit is set or IP frag -number is non-zero. If set indicates that this is a -fragmented IP packet. - -tcp_only_ack -Set if only the TCP Ack bit is set in the TCP flags and if -the TCP payload is 0. - -sa_idx -The offset in the address table which matches the MAC source -address. - -reserved_2b -Reserved: HW should fill with zero. FW should ignore. -*/ +* msdu_length +* MSDU length in bytes after decapsulation. This field is +* still valid for MPDU frames without A-MSDU. It still +* represents MSDU length after decapsulation +* +* ip_offset +* Indicates the IP offset in bytes from the start of the +* packet after decapsulation. Only valid if ipv4_proto or +* ipv6_proto is set. +* +* ring_mask +* Indicates the destination RX rings for this MSDU. +* +* tcp_udp_offset +* Indicates the offset in bytes to the start of TCP or UDP +* header from the start of the IP header after decapsulation. +* Only valid if tcp_prot or udp_prot is set. The value 0 +* indicates that the offset is longer than 127 bytes. +* +* reserved_0c +* Reserved: HW should fill with zero. FW should ignore. +* +* flow_id_crc +* The flow_id_crc runs CRC32 on the following information: +* IPv4 option: dest_addr[31:0], src_addr [31:0], {24'b0, +* protocol[7:0]}. +* IPv6 option: dest_addr[127:0], src_addr [127:0], {24'b0, +* next_header[7:0]} +* UDP case: sort_port[15:0], dest_port[15:0] +* TCP case: sort_port[15:0], dest_port[15:0], +* {header_length[3:0], 6'b0, flags[5:0], window_size[15:0]}, +* {16'b0, urgent_ptr[15:0]}, all options except 32-bit +* timestamp. +* +* msdu_number +* Indicates the MSDU number within a MPDU. This value is +* reset to zero at the start of each MPDU. If the number of +* MSDU exceeds 255 this number will wrap using modulo 256. +* +* decap_format +* Indicates the format after decapsulation: +* 0: RAW: No decapsulation +* 1: Native WiFi +* 2: Ethernet 2 (DIX) +* 3: 802.3 (SNAP/LLC) +* +* ipv4_proto +* Set if L2 layer indicates IPv4 protocol. +* +* ipv6_proto +* Set if L2 layer indicates IPv6 protocol. +* +* tcp_proto +* Set if the ipv4_proto or ipv6_proto are set and the IP +* protocol indicates TCP. +* +* udp_proto +* Set if the ipv4_proto or ipv6_proto are set and the IP +* protocol indicates UDP. +* +* ip_frag +* Indicates that either the IP More frag bit is set or IP frag +* number is non-zero. If set indicates that this is a +* fragmented IP packet. +* +* tcp_only_ack +* Set if only the TCP Ack bit is set in the TCP flags and if +* the TCP payload is 0. +* +* sa_idx +* The offset in the address table which matches the MAC source +* address. +* +* reserved_2b +* Reserved: HW should fill with zero. FW should ignore. +*/ #define RX_MSDU_END_INFO0_REPORTED_MPDU_LENGTH_MASK 0x00003fff#define RX_MSDU_END_INFO0_REPORTED_MPDU_LENGTH_LSB 0
@@ -530,64 +530,64 @@ struct rx_msdu_end { } __packed;/* -ip_hdr_chksum -This can include the IP header checksum or the pseudo header -checksum used by TCP/UDP checksum. - -tcp_udp_chksum -The value of the computed TCP/UDP checksum. A mode bit -selects whether this checksum is the full checksum or the -partial checksum which does not include the pseudo header. - -key_id_octet -The key ID octet from the IV. Only valid when first_msdu is -set. - -classification_filter -Indicates the number classification filter rule - -ext_wapi_pn_63_48 -Extension PN (packet number) which is only used by WAPI. -This corresponds to WAPI PN bits [63:48] (pn6 and pn7). The -WAPI PN bits [63:0] are in the pn field of the rx_mpdu_start -descriptor. - -ext_wapi_pn_95_64 -Extension PN (packet number) which is only used by WAPI. -This corresponds to WAPI PN bits [95:64] (pn8, pn9, pn10 and -pn11). - -ext_wapi_pn_127_96 -Extension PN (packet number) which is only used by WAPI. -This corresponds to WAPI PN bits [127:96] (pn12, pn13, pn14, -pn15). - -reported_mpdu_length -MPDU length before decapsulation. Only valid when -first_msdu is set. This field is taken directly from the -length field of the A-MPDU delimiter or the preamble length -field for non-A-MPDU frames. - -first_msdu -Indicates the first MSDU of A-MSDU. If both first_msdu and -last_msdu are set in the MSDU then this is a non-aggregated -MSDU frame: normal MPDU. Interior MSDU in an A-MSDU shall -have both first_mpdu and last_mpdu bits set to 0. - -last_msdu -Indicates the last MSDU of the A-MSDU. MPDU end status is -only valid when last_msdu is set. - -reserved_3a -Reserved: HW should fill with zero. FW should ignore. - -pre_delim_err -Indicates that the first delimiter had a FCS failure. Only -valid when first_mpdu and first_msdu are set. - -reserved_3b -Reserved: HW should fill with zero. FW should ignore. -*/ +*ip_hdr_chksum +* This can include the IP header checksum or the pseudo header +* checksum used by TCP/UDP checksum. +* +*tcp_udp_chksum +* The value of the computed TCP/UDP checksum. A mode bit +* selects whether this checksum is the full checksum or the +* partial checksum which does not include the pseudo header. +* +*key_id_octet +* The key ID octet from the IV. Only valid when first_msdu is +* set. +* +*classification_filter +* Indicates the number classification filter rule +* +*ext_wapi_pn_63_48 +* Extension PN (packet number) which is only used by WAPI. +* This corresponds to WAPI PN bits [63:48] (pn6 and pn7). The +* WAPI PN bits [63:0] are in the pn field of the rx_mpdu_start +* descriptor. +* +*ext_wapi_pn_95_64 +* Extension PN (packet number) which is only used by WAPI. +* This corresponds to WAPI PN bits [95:64] (pn8, pn9, pn10 and +* pn11). +* +*ext_wapi_pn_127_96 +* Extension PN (packet number) which is only used by WAPI. +* This corresponds to WAPI PN bits [127:96] (pn12, pn13, pn14, +* pn15). +* +*reported_mpdu_length +* MPDU length before decapsulation. Only valid when +* first_msdu is set. This field is taken directly from the +* length field of the A-MPDU delimiter or the preamble length +* field for non-A-MPDU frames. +* +*first_msdu +* Indicates the first MSDU of A-MSDU. If both first_msdu and +* last_msdu are set in the MSDU then this is a non-aggregated +* MSDU frame: normal MPDU. Interior MSDU in an A-MSDU shall +* have both first_mpdu and last_mpdu bits set to 0. +* +*last_msdu +* Indicates the last MSDU of the A-MSDU. MPDU end status is +* only valid when last_msdu is set. +* +*reserved_3a +* Reserved: HW should fill with zero. FW should ignore. +* +*pre_delim_err +* Indicates that the first delimiter had a FCS failure. Only +* valid when first_mpdu and first_msdu are set. +* +*reserved_3b +* Reserved: HW should fill with zero. FW should ignore. +*/ #define RX_PPDU_START_SIG_RATE_SELECT_OFDM 0#define RX_PPDU_START_SIG_RATE_SELECT_CCK 1
@@ -659,164 +659,164 @@ struct rx_ppdu_start { } __packed;/* -rssi_chain0_pri20 -RSSI of RX PPDU on chain 0 of primary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain0_sec20 -RSSI of RX PPDU on chain 0 of secondary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain0_sec40 -RSSI of RX PPDU on chain 0 of secondary 40 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain0_sec80 -RSSI of RX PPDU on chain 0 of secondary 80 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain1_pri20 -RSSI of RX PPDU on chain 1 of primary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain1_sec20 -RSSI of RX PPDU on chain 1 of secondary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain1_sec40 -RSSI of RX PPDU on chain 1 of secondary 40 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain1_sec80 -RSSI of RX PPDU on chain 1 of secondary 80 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain2_pri20 -RSSI of RX PPDU on chain 2 of primary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain2_sec20 -RSSI of RX PPDU on chain 2 of secondary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain2_sec40 -RSSI of RX PPDU on chain 2 of secondary 40 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain2_sec80 -RSSI of RX PPDU on chain 2 of secondary 80 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain3_pri20 -RSSI of RX PPDU on chain 3 of primary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain3_sec20 -RSSI of RX PPDU on chain 3 of secondary 20 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain3_sec40 -RSSI of RX PPDU on chain 3 of secondary 40 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_chain3_sec80 -RSSI of RX PPDU on chain 3 of secondary 80 MHz bandwidth. -Value of 0x80 indicates invalid. - -rssi_comb -The combined RSSI of RX PPDU of all active chains and -bandwidths. Value of 0x80 indicates invalid. - -reserved_4a -Reserved: HW should fill with 0, FW should ignore. - -is_greenfield -Do we really support this? - -reserved_4b -Reserved: HW should fill with 0, FW should ignore. - -l_sig_rate -If l_sig_rate_select is 0: -0x8: OFDM 48 Mbps -0x9: OFDM 24 Mbps -0xA: OFDM 12 Mbps -0xB: OFDM 6 Mbps -0xC: OFDM 54 Mbps -0xD: OFDM 36 Mbps -0xE: OFDM 18 Mbps -0xF: OFDM 9 Mbps -If l_sig_rate_select is 1: -0x8: CCK 11 Mbps long preamble -0x9: CCK 5.5 Mbps long preamble -0xA: CCK 2 Mbps long preamble -0xB: CCK 1 Mbps long preamble -0xC: CCK 11 Mbps short preamble -0xD: CCK 5.5 Mbps short preamble -0xE: CCK 2 Mbps short preamble - -l_sig_rate_select -Legacy signal rate select. If set then l_sig_rate indicates -CCK rates. If clear then l_sig_rate indicates OFDM rates. - -l_sig_length -Length of legacy frame in octets. - -l_sig_parity -Odd parity over l_sig_rate and l_sig_length - -l_sig_tail -Tail bits for Viterbi decoder - -preamble_type -Indicates the type of preamble ahead: -0x4: Legacy (OFDM/CCK) -0x8: HT -0x9: HT with TxBF -0xC: VHT -0xD: VHT with TxBF -0x80 - 0xFF: Reserved for special baseband data types such -as radar and spectral scan. - -ht_sig_vht_sig_a_1 -If preamble_type == 0x8 or 0x9 -HT-SIG (first 24 bits) -If preamble_type == 0xC or 0xD -VHT-SIG A (first 24 bits) -Else -Reserved - -reserved_6 -Reserved: HW should fill with 0, FW should ignore. - -ht_sig_vht_sig_a_2 -If preamble_type == 0x8 or 0x9 -HT-SIG (last 24 bits) -If preamble_type == 0xC or 0xD -VHT-SIG A (last 24 bits) -Else -Reserved - -txbf_h_info -Indicates that the packet data carries H information which -is used for TxBF debug. - -reserved_7 -Reserved: HW should fill with 0, FW should ignore. - -vht_sig_b -WiFi 1.0 and WiFi 2.0 will likely have this field to be all -0s since the BB does not plan on decoding VHT SIG-B. - -reserved_8 -Reserved: HW should fill with 0, FW should ignore. - -service -Service field from BB for OFDM, HT and VHT packets. CCK -packets will have service field of 0. - -reserved_9 -Reserved: HW should fill with 0, FW should ignore. +* rssi_chain0_pri20 +* RSSI of RX PPDU on chain 0 of primary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain0_sec20 +* RSSI of RX PPDU on chain 0 of secondary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain0_sec40 +* RSSI of RX PPDU on chain 0 of secondary 40 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain0_sec80 +* RSSI of RX PPDU on chain 0 of secondary 80 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain1_pri20 +* RSSI of RX PPDU on chain 1 of primary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain1_sec20 +* RSSI of RX PPDU on chain 1 of secondary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain1_sec40 +* RSSI of RX PPDU on chain 1 of secondary 40 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain1_sec80 +* RSSI of RX PPDU on chain 1 of secondary 80 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain2_pri20 +* RSSI of RX PPDU on chain 2 of primary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain2_sec20 +* RSSI of RX PPDU on chain 2 of secondary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain2_sec40 +* RSSI of RX PPDU on chain 2 of secondary 40 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain2_sec80 +* RSSI of RX PPDU on chain 2 of secondary 80 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain3_pri20 +* RSSI of RX PPDU on chain 3 of primary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain3_sec20 +* RSSI of RX PPDU on chain 3 of secondary 20 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain3_sec40 +* RSSI of RX PPDU on chain 3 of secondary 40 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_chain3_sec80 +* RSSI of RX PPDU on chain 3 of secondary 80 MHz bandwidth. +* Value of 0x80 indicates invalid. +* +* rssi_comb +* The combined RSSI of RX PPDU of all active chains and +* bandwidths. Value of 0x80 indicates invalid. +* +* reserved_4a +* Reserved: HW should fill with 0, FW should ignore. +* +* is_greenfield +* Do we really support this? +* +* reserved_4b +* Reserved: HW should fill with 0, FW should ignore. +* +* l_sig_rate +* If l_sig_rate_select is 0: +* 0x8: OFDM 48 Mbps +* 0x9: OFDM 24 Mbps +* 0xA: OFDM 12 Mbps +* 0xB: OFDM 6 Mbps +* 0xC: OFDM 54 Mbps +* 0xD: OFDM 36 Mbps +* 0xE: OFDM 18 Mbps +* 0xF: OFDM 9 Mbps +* If l_sig_rate_select is 1: +* 0x8: CCK 11 Mbps long preamble +* 0x9: CCK 5.5 Mbps long preamble +* 0xA: CCK 2 Mbps long preamble +* 0xB: CCK 1 Mbps long preamble +* 0xC: CCK 11 Mbps short preamble +* 0xD: CCK 5.5 Mbps short preamble +* 0xE: CCK 2 Mbps short preamble +* +* l_sig_rate_select +* Legacy signal rate select. If set then l_sig_rate indicates +* CCK rates. If clear then l_sig_rate indicates OFDM rates. +* +* l_sig_length +* Length of legacy frame in octets. +* +* l_sig_parity +* Odd parity over l_sig_rate and l_sig_length +* +* l_sig_tail +* Tail bits for Viterbi decoder +* +* preamble_type +* Indicates the type of preamble ahead: +* 0x4: Legacy (OFDM/CCK) +* 0x8: HT +* 0x9: HT with TxBF +* 0xC: VHT +* 0xD: VHT with TxBF +* 0x80 - 0xFF: Reserved for special baseband data types such +* as radar and spectral scan. +* +* ht_sig_vht_sig_a_1 +* If preamble_type == 0x8 or 0x9 +* HT-SIG (first 24 bits) +* If preamble_type == 0xC or 0xD +* VHT-SIG A (first 24 bits) +* Else +* Reserved +* +* reserved_6 +* Reserved: HW should fill with 0, FW should ignore. +* +* ht_sig_vht_sig_a_2 +* If preamble_type == 0x8 or 0x9 +* HT-SIG (last 24 bits) +* If preamble_type == 0xC or 0xD +* VHT-SIG A (last 24 bits) +* Else +* Reserved +* +* txbf_h_info +* Indicates that the packet data carries H information which +* is used for TxBF debug. +* +* reserved_7 +* Reserved: HW should fill with 0, FW should ignore. +* +* vht_sig_b +* WiFi 1.0 and WiFi 2.0 will likely have this field to be all +* 0s since the BB does not plan on decoding VHT SIG-B. +* +* reserved_8 +* Reserved: HW should fill with 0, FW should ignore. +* +* service +* Service field from BB for OFDM, HT and VHT packets. CCK +* packets will have service field of 0. +* +* reserved_9 +* Reserved: HW should fill with 0, FW should ignore. */
@@ -859,122 +859,122 @@ struct rx_ppdu_end { } __packed;/* -evm_p0 -EVM for pilot 0. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p1 -EVM for pilot 1. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p2 -EVM for pilot 2. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p3 -EVM for pilot 3. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p4 -EVM for pilot 4. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p5 -EVM for pilot 5. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p6 -EVM for pilot 6. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p7 -EVM for pilot 7. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p8 -EVM for pilot 8. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p9 -EVM for pilot 9. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p10 -EVM for pilot 10. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p11 -EVM for pilot 11. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p12 -EVM for pilot 12. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p13 -EVM for pilot 13. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p14 -EVM for pilot 14. Contain EVM for streams: 0, 1, 2 and 3. - -evm_p15 -EVM for pilot 15. Contain EVM for streams: 0, 1, 2 and 3. - -tsf_timestamp -Receive TSF timestamp sampled on the rising edge of -rx_clear. For PHY errors this may be the current TSF when -phy_error is asserted if the rx_clear does not assert before -the end of the PHY error. - -wb_timestamp -WLAN/BT timestamp is a 1 usec resolution timestamp which -does not get updated based on receive beacon like TSF. The -same rules for capturing tsf_timestamp are used to capture -the wb_timestamp. - -locationing_timestamp -Timestamp used for locationing. This timestamp is used to -indicate fractions of usec. For example if the MAC clock is -running at 80 MHz, the timestamp will increment every 12.5 -nsec. The value starts at 0 and increments to 79 and -returns to 0 and repeats. This information is valid for -every PPDU. This information can be used in conjunction -with wb_timestamp to capture large delta times. - -phy_err_code -See the 1.10.8.1.2 for the list of the PHY error codes. - -phy_err -Indicates a PHY error was detected for this PPDU. - -rx_location -Indicates that location information was requested. - -txbf_h_info -Indicates that the packet data carries H information which -is used for TxBF debug. - -reserved_18 -Reserved: HW should fill with 0, FW should ignore. - -rx_antenna -Receive antenna value - -tx_ht_vht_ack -Indicates that a HT or VHT Ack/BA frame was transmitted in -response to this receive packet. - -bb_captured_channel -Indicates that the BB has captured a channel dump. FW can -then read the channel dump memory. This may indicate that -the channel was captured either based on PCU setting the -capture_channel bit BB descriptor or FW setting the -capture_channel mode bit. - -reserved_19 -Reserved: HW should fill with 0, FW should ignore. - -bb_length -Indicates the number of bytes of baseband information for -PPDUs where the BB descriptor preamble type is 0x80 to 0xFF -which indicates that this is not a normal PPDU but rather -contains baseband debug information. - -reserved_20 -Reserved: HW should fill with 0, FW should ignore. - -ppdu_done -PPDU end status is only valid when ppdu_done bit is set. -Every time HW sets this bit in memory FW/SW must clear this -bit in memory. FW will initialize all the ppdu_done dword -to 0. +* evm_p0 +* EVM for pilot 0. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p1 +* EVM for pilot 1. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p2 +* EVM for pilot 2. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p3 +* EVM for pilot 3. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p4 +* EVM for pilot 4. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p5 +* EVM for pilot 5. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p6 +* EVM for pilot 6. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p7 +* EVM for pilot 7. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p8 +* EVM for pilot 8. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p9 +* EVM for pilot 9. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p10 +* EVM for pilot 10. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p11 +* EVM for pilot 11. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p12 +* EVM for pilot 12. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p13 +* EVM for pilot 13. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p14 +* EVM for pilot 14. Contain EVM for streams: 0, 1, 2 and 3. +* +* evm_p15 +* EVM for pilot 15. Contain EVM for streams: 0, 1, 2 and 3. +* +* tsf_timestamp +* Receive TSF timestamp sampled on the rising edge of +* rx_clear. For PHY errors this may be the current TSF when +* phy_error is asserted if the rx_clear does not assert before +* the end of the PHY error. +* +* wb_timestamp +* WLAN/BT timestamp is a 1 usec resolution timestamp which +* does not get updated based on receive beacon like TSF. The +* same rules for capturing tsf_timestamp are used to capture +* the wb_timestamp. +* +* locationing_timestamp +* Timestamp used for locationing. This timestamp is used to +* indicate fractions of usec. For example if the MAC clock is +* running at 80 MHz, the timestamp will increment every 12.5 +* nsec. The value starts at 0 and increments to 79 and +* returns to 0 and repeats. This information is valid for +* every PPDU. This information can be used in conjunction +* with wb_timestamp to capture large delta times. +* +* phy_err_code +* See the 1.10.8.1.2 for the list of the PHY error codes. +* +* phy_err +* Indicates a PHY error was detected for this PPDU. +* +* rx_location +* Indicates that location information was requested. +* +* txbf_h_info +* Indicates that the packet data carries H information which +* is used for TxBF debug. +* +* reserved_18 +* Reserved: HW should fill with 0, FW should ignore. +* +* rx_antenna +* Receive antenna value +* +* tx_ht_vht_ack +* Indicates that a HT or VHT Ack/BA frame was transmitted in +* response to this receive packet. +* +* bb_captured_channel +* Indicates that the BB has captured a channel dump. FW can +* then read the channel dump memory. This may indicate that +* the channel was captured either based on PCU setting the +* capture_channel bit BB descriptor or FW setting the +* capture_channel mode bit. +* +* reserved_19 +* Reserved: HW should fill with 0, FW should ignore. +* +* bb_length +* Indicates the number of bytes of baseband information for +* PPDUs where the BB descriptor preamble type is 0x80 to 0xFF +* which indicates that this is not a normal PPDU but rather +* contains baseband debug information. +* +* reserved_20 +* Reserved: HW should fill with 0, FW should ignore. +* +* ppdu_done +* PPDU end status is only valid when ppdu_done bit is set. +* Every time HW sets this bit in memory FW/SW must clear this +* bit in memory. FW will initialize all the ppdu_done dword +* to 0. */ #define FW_RX_DESC_INFO0_DISCARD (1 << 0)
Signature · 1 line
1.7.10
Kalle Valo
AppliedPATCH 1/1 ath10k: fix comments style in rx_desc.h file
Quoted 2 lines · Bartosz Markowski
Signed-off-by Bartosz Markowski <[email protected]>---
Thanks, applied.
Signature · 1 line
Kalle Valo