zephyr
/
nrf_hw_models
mirror of https://github.com/zephyrproject-rtos/nrf_hw_models.git
1
0
Fork 0
Code Issues Releases Wiki Activity

RADIO: Handle MAXLEN and other related improvements 

Cap the Tx length by MAXLEN when doing a Tx.
(Note that just like in real HW, the transmitted length
field is not altered, so the actual Tx'ed packet is corrupted)

During Rx, handle properly MAXLEN:
Instead of erroring out when the received length is more than
MAXLEN, properly truncate the length during reception.

Check PCNF1 configuration for BLE modulation, to ensure
we only got a configuration we support.
(As other configurations are ignored).

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
This commit is contained in:
Alberto Escolar Piedras 2023-08-21 16:10:26 +02:00
parent acbbc929b8
commit aa8d6f67f5
3 changed files with 101 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
src/HW_models/NRF_RADIO.c
View File

@ -10,7 +10,7 @@
* https://infocenter.nordicsemi.com/topic/ps_nrf52833/radio.html?cp=5_1_0_5_17
*
* Note: as of now, only 1&2Mbps BLE & 15.4 packet formats are supported, there is quite many notes around in the code
* where changes would be required to support other formats
* where changes would be required to support other formats. PCNF1.STATLEN is always assumed 0
*
* Note3: Only logical address 0 (in Tx or Rx) is supported
*
@ -29,7 +29,9 @@
* MODE @ TXEN | RXEN
* CRC config @ START
*
* Note10: Maxlength is only partially checked (the packet is cut, but the interaction with the phy is not proper)
* Note10: Regarding MAXLEN:
* if CRCINC==1, the CRC LEN is deducted from the length field, before MAXLEN is checked.
* It is unclear from the spec if this is the real HW behaviour
*
* Note11: Only the BLE & 15.4 CRC polynomials are supported
* During reception we assume that CRCPOLY and CRCINIT are correct on both sides, and just rely on the phy bit error reporting to save processing time
@ -87,7 +89,6 @@
*
* Note23: Powering off/on is not properly modeled (it is mostly ignored)
*
*
* Implementation Specification:
* A diagram of the main state machine can be found in docs/RADIO_states.svg
* That main state machine is driven by a timer (Timer_RADIO) which results in calls to nrf_radio_timer_triggered()
@ -290,6 +291,11 @@ static void abort_if_needed(){
//If the phy is waiting for a response from us, we need to tell it, that we are aborting whatever it was doing
aborting_set = 1;
}
/* Note: In Rx, we may be
* waiting to respond to the Phy to an abort reevaluation request abort_fsm_state == Rx_Abort_reeval
* or waiting to reach the address end time to respond to the Phy if we accepted the packet or not
* but not both
*/
if ( radio_sub_state == RX_WAIT_FOR_ADDRESS_END ){
//we answer immediately to the phy rejecting the packet
p2G4_dev_rxv2_cont_after_addr_nc_b(false, NULL);
@ -730,7 +736,6 @@ static void start_Tx(){
uint8_t address_len;
uint8_t header_len;
uint payload_len;
//Note: I assume in Tx the length is always < PCNF1.MAXLEN and that STATLEN is always 0 (otherwise add a check)
uint8_t crc_len = nrfra_get_crc_length();
if (NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_1Mbit) {
@ -796,23 +801,8 @@ static void Rx_handle_end_response(bs_time_t end_time) {
//packet lenght was received correctly, and just report a CRC error at the
//end of the CRC
uint payload_len = nrfra_get_payload_length(rx_buf);
uint crc_len = nrfra_get_crc_length();
if ( rx_status.rx_resp.status == P2G4_RXSTATUS_OK ){
//Let's copy the CRC
uint32_t crc = 0;
//Eventually this should be generalized with the packet configuration
if (((NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_1Mbit)
|| (NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_2Mbit))
&& ( rx_status.rx_resp.packet_size >= 5 ) ){
memcpy((void*)&crc, &rx_buf[2 + payload_len], crc_len);
} else if ((NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ieee802154_250Kbit)
&& ( rx_status.rx_resp.packet_size >= 3 ) ){
memcpy((void*)&crc, &rx_buf[1 + payload_len], crc_len);
}
NRF_RADIO_regs.RXCRC = crc;
NRF_RADIO_regs.RXCRC = nrfra_get_rx_crc_value(rx_buf, rx_status.rx_resp.packet_size);
rx_status.CRC_OK = 1;
NRF_RADIO_regs.CRCSTATUS = 1;
}
@ -826,20 +816,21 @@ static void Rx_handle_address_end_response(bs_time_t address_time) {
rx_status.ADDRESS_End_Time = address_time + nrfra_timings_get_Rx_chain_delay();
uint length = nrfra_get_payload_length(rx_buf);
uint max_length = (NRF_RADIO_regs.PCNF1 & NFCT_MAXLEN_MAXLEN_Msk) >> NFCT_MAXLEN_MAXLEN_Pos;
uint max_length = nrfra_get_MAXLEN();
if (length > max_length){
bs_trace_error_time_line("NRF_RADIO: received a packet longer than the configured max lenght (%i>%i), this is not yet handled in this models. I stop before it gets confusing\n", length, max_length);
if (length > max_length) {
// We reject the packet right away, setting the CRC error, and timers as expected
bs_trace_warning_time_line("NRF_RADIO: received a packet longer than the configured MAXLEN (%i>%i). Truncating it\n", length, max_length);
length = max_length;
//TODO: check packet length. If too long the packet should be truncated and not accepted from the phy, [we already have it in the buffer and we will have a CRC error anyhow. And we cannot let the phy run for longer than we will]
NRF_RADIO_regs.PDUSTAT = RADIO_PDUSTAT_PDUSTAT_Msk;
rx_status.packet_rejected = true;
} else {
//NRF_RADIO_regs.PDUSTAT = 0; //TODO, set if greater
NRF_RADIO_regs.PDUSTAT = 0;
rx_status.packet_rejected = false;
}
//TODO: Discard Ieee802154_250Kbit frames with length == 0
rx_status.packet_rejected = false;
bs_time_t payload_end;
if ((NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_1Mbit)
@ -852,7 +843,7 @@ static void Rx_handle_address_end_response(bs_time_t address_time) {
rx_status.PAYLOAD_End_Time = nrfra_timings_get_Rx_chain_delay() +
hwll_dev_time_from_phy(payload_end);
rx_status.CRC_End_Time = rx_status.PAYLOAD_End_Time + rx_status.CRC_duration; //Provisional value
rx_status.CRC_End_Time = rx_status.PAYLOAD_End_Time + rx_status.CRC_duration; //Provisional value (if we are accepting the packet)
//Copy the whole packet (S0, lenght, S1 & payload) excluding the CRC.
if ((NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_1Mbit)
@ -1011,7 +1002,11 @@ static void Rx_Addr_received(){
if ( accept_packet ){
handle_Rx_response(ret);
} else {
//else We said we dont want to continue => there will be no response (ret==0 always). We just close the reception like if the phy finished on its own even though we finished it
//We said we don't want to continue => there will be no response (ret==0 always). We just close the reception like if the phy finished on its own even though we finished it
//We do what would correspond to Rx_handle_end_response() as it won't get called
NRF_RADIO_regs.RXCRC = nrfra_get_rx_crc_value(rx_buf, rx_status.rx_resp.packet_size);
nrf_ccm_radio_received_packet(!rx_status.CRC_OK);
}
}

75
src/HW_models/NRF_RADIO_utils.c
View File

@ -26,6 +26,26 @@ static void nrfra_check_crc_conf_ble(void) {
}
}
static void nrfra_check_pcnf1_ble(void) {
int checked, check;
checked = NRF_RADIO_regs.PCNF1 &
( RADIO_PCNF1_WHITEEN_Msk
| RADIO_PCNF1_ENDIAN_Msk
| RADIO_PCNF1_BALEN_Msk
| RADIO_PCNF1_STATLEN_Msk );
check = (1 << RADIO_PCNF1_WHITEEN_Pos)
| (RADIO_PCNF1_ENDIAN_Little << RADIO_PCNF1_ENDIAN_Pos)
| (3 << RADIO_PCNF1_BALEN_Pos) //4 bytes address
| (0 << RADIO_PCNF1_STATLEN_Pos);
if (checked != check) {
bs_trace_error_line_time(
"%s w 1|2Mbps BLE modulation only the BLE packet format is supported so far (PCNF1=%u)\n",
__func__, NRF_RADIO_regs.PCNF1);
}
}
static void nrfra_check_ble1M_conf(void){
int checked =NRF_RADIO_regs.PCNF0 &
(RADIO_PCNF0_PLEN_Msk
@ -44,6 +64,7 @@ static void nrfra_check_ble1M_conf(void){
NRF_RADIO_regs.PCNF0);
}
nrfra_check_pcnf1_ble();
nrfra_check_crc_conf_ble();
}
@ -66,6 +87,7 @@ static void nrfra_check_ble2M_conf(void){
NRF_RADIO_regs.PCNF0);
}
nrfra_check_pcnf1_ble();
nrfra_check_crc_conf_ble();
}
@ -387,8 +409,14 @@ uint nrfra_get_crc_length(){
return (NRF_RADIO_regs.CRCCNF & RADIO_CRCCNF_LEN_Msk) >> RADIO_CRCCNF_LEN_Pos;
}
uint nrfra_get_MAXLEN(void) {
return (NRF_RADIO_regs.PCNF1 & NFCT_MAXLEN_MAXLEN_Msk) >> NFCT_MAXLEN_MAXLEN_Pos;
}
/*
* Return the payload length, NOT including the CRC length
* (and NOT adding S0 or S1 lengths)
*/
uint nrfra_get_payload_length(uint8_t *buf){
int S0Len;
@ -416,6 +444,35 @@ uint nrfra_get_payload_length(uint8_t *buf){
return payload_len;
}
uint nrfra_get_capped_payload_length(uint8_t *buf) {
uint payload_lenght = nrfra_get_payload_length(buf);
uint max_length = nrfra_get_MAXLEN();
return BS_MIN(payload_lenght, max_length);
}
/*
* Get the received CRC value from the received buffer
* paramters:
* rx_buf: Pointer to the received buffer
* rx_packet_size: Number of input bytes in rx_buf
*/
uint32_t nrfra_get_rx_crc_value(uint8_t *rx_buf, size_t rx_packet_size) {
uint32_t crc = 0;
uint crc_len = nrfra_get_crc_length();
uint payload_len = nrfra_get_capped_payload_length(rx_buf);
//Eventually this should be generalized with the packet configuration
if (((NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_1Mbit)
|| (NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ble_2Mbit))
&& ( rx_packet_size >= 5 ) ){
memcpy((void*)&crc, &rx_buf[2 + payload_len], crc_len);
} else if ((NRF_RADIO_regs.MODE == RADIO_MODE_MODE_Ieee802154_250Kbit)
&& ( rx_packet_size >= 3 ) ){
memcpy((void*)&crc, &rx_buf[1 + payload_len], crc_len);
}
return crc;
}
/**
* Assemble a packet to be transmitted out thru the air into tx_buf[]
* Omitting the preamble and address/sync flag
@ -423,6 +480,8 @@ uint nrfra_get_payload_length(uint8_t *buf){
* Return copied payload size (after S0 + len + S1) into tx_buf[]
* (without the CRC)
*
* Note: PCNF1.MAXLEN is taken into account to cap len
*
* Note: When adding support for CodedPhy and or other packet formats,
* this needs to be reworked together with the start_Tx()
* function, as it is all way too interdependent
@ -432,6 +491,7 @@ uint nrfra_tx_copy_payload(uint8_t *tx_buf){
int LFLenb, S1LenAirb;
int i;
uint payload_len;
int maxlen;
S0Len = (NRF_RADIO_regs.PCNF0 & RADIO_PCNF0_S0LEN_Msk) >> RADIO_PCNF0_S0LEN_Pos;
@ -465,6 +525,21 @@ uint nrfra_tx_copy_payload(uint8_t *tx_buf){
}
payload_len = nrfra_get_payload_length(tx_buf);
/* Note that we assume if CRCINC=1, CRCLEN is deducted from the length field
* before capping the length to MAXLEN */
maxlen = nrfra_get_MAXLEN();
if (payload_len > maxlen) {
bs_trace_error_time_line("NRF_RADIO: Transmitting a packet longer than the configured MAXLEN (%i>%i). "
"This would truncate it and a corrupted packet will be transmitted. "
"Assuming this is a controller programming error, so we stop here. "
"If you did really intend this, please request this error to be converted into a warning "
"(the model handles this properly)\n", payload_len, maxlen);
payload_len = maxlen;
NRF_RADIO_regs.PDUSTAT = RADIO_PDUSTAT_PDUSTAT_Msk;
} else {
NRF_RADIO_regs.PDUSTAT = 0;
}
int copy_len = payload_len + S1LenB;
memcpy(&tx_buf[i], &((uint8_t*)NRF_RADIO_regs.PACKETPTR)[i + S1Off], copy_len);
return payload_len;

2
src/HW_models/NRF_RADIO_utils.h
View File

@ -25,7 +25,9 @@ void nrfra_prep_cca_request(p2G4_cca_t *cca_req, bool CCA_not_ED);
uint nrfra_tx_copy_payload(uint8_t *tx_buf);
uint nrfra_get_payload_length(uint8_t *buf);
uint32_t nrfra_get_rx_crc_value(uint8_t *rx_buf, size_t rx_packet_size);
uint nrfra_get_crc_length();
uint nrfra_get_MAXLEN(void);
#ifdef __cplusplus
}