|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, Nordic Semiconductor ASA |
| 3 | + * All rights reserved. |
| 4 | + * |
| 5 | + * SPDX-License-Identifier: BSD-3-Clause |
| 6 | + * |
| 7 | + * Redistribution and use in source and binary forms, with or without |
| 8 | + * modification, are permitted provided that the following conditions are met: |
| 9 | + * |
| 10 | + * 1. Redistributions of source code must retain the above copyright notice, this |
| 11 | + * list of conditions and the following disclaimer. |
| 12 | + * |
| 13 | + * 2. Redistributions in binary form must reproduce the above copyright |
| 14 | + * notice, this list of conditions and the following disclaimer in the |
| 15 | + * documentation and/or other materials provided with the distribution. |
| 16 | + * |
| 17 | + * 3. Neither the name of Nordic Semiconductor ASA nor the names of its |
| 18 | + * contributors may be used to endorse or promote products derived from this |
| 19 | + * software without specific prior written permission. |
| 20 | + * |
| 21 | + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 22 | + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 23 | + * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE |
| 24 | + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| 25 | + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 26 | + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 27 | + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 28 | + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 29 | + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 30 | + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 31 | + * POSSIBILITY OF SUCH DAMAGE. |
| 32 | + * |
| 33 | + */ |
| 34 | + |
| 35 | +/** |
| 36 | + * @file |
| 37 | + * This file implements the transmit timestamp provider for the 802.15.4 driver. |
| 38 | + * |
| 39 | + */ |
| 40 | + |
| 41 | +#include "mac_features/nrf_802154_tx_timestamp_provider.h" |
| 42 | + |
| 43 | +#include "mac_features/nrf_802154_frame_parser.h" |
| 44 | +#include "nrf_802154_utils_byteorder.h" |
| 45 | +#include "nrf_802154_sl_timer.h" |
| 46 | + |
| 47 | +#if NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED |
| 48 | + |
| 49 | +static uint64_t m_tx_timestamp_us; ///< Cached transmit timestamp. |
| 50 | +static uint8_t * mp_tx_timestamp_addr; ///< Cached tx timestamp placeholder address. |
| 51 | + |
| 52 | +bool nrf_802154_tx_timestamp_provider_tx_setup( |
| 53 | + uint8_t * p_frame, |
| 54 | + nrf_802154_transmit_params_t * p_params, |
| 55 | + nrf_802154_transmit_failed_notification_t notify_function) |
| 56 | +{ |
| 57 | + nrf_802154_frame_parser_data_t frame_data; |
| 58 | + bool result = false; |
| 59 | + |
| 60 | + m_tx_timestamp_us = 0; |
| 61 | + mp_tx_timestamp_addr = NULL; |
| 62 | + |
| 63 | + if (p_params->tx_timestamp_encode == false) |
| 64 | + { |
| 65 | + // There is nothing to do. |
| 66 | + return true; |
| 67 | + } |
| 68 | + |
| 69 | + do |
| 70 | + { |
| 71 | + if (p_params->frame_props.is_secured) |
| 72 | + { |
| 73 | + result = false; |
| 74 | + break; |
| 75 | + } |
| 76 | + |
| 77 | + result = nrf_802154_frame_parser_data_init(p_frame, |
| 78 | + p_frame[PHR_OFFSET] + |
| 79 | + PHR_SIZE, |
| 80 | + PARSE_LEVEL_FULL, |
| 81 | + &frame_data); |
| 82 | + |
| 83 | + if (result == false) |
| 84 | + { |
| 85 | + break; |
| 86 | + } |
| 87 | + |
| 88 | + if (nrf_802154_frame_parser_frame_type_get(&frame_data) != FRAME_TYPE_DATA) |
| 89 | + { |
| 90 | + result = false; |
| 91 | + break; |
| 92 | + } |
| 93 | + |
| 94 | + if (nrf_802154_frame_parser_mac_payload_get(&frame_data) == NULL) |
| 95 | + { |
| 96 | + result = false; |
| 97 | + break; |
| 98 | + } |
| 99 | + |
| 100 | + uint8_t payload_len = nrf_802154_frame_parser_mac_payload_length_get(&frame_data); |
| 101 | + |
| 102 | + if (payload_len < NRF_802154_TX_TIMESTAMP_PROVIDER_TIMESTAMP_SIZE) |
| 103 | + { |
| 104 | + result = false; |
| 105 | + break; |
| 106 | + } |
| 107 | + |
| 108 | + mp_tx_timestamp_addr = (uint8_t *)(nrf_802154_frame_parser_mac_payload_get(&frame_data) + |
| 109 | + payload_len - |
| 110 | + NRF_802154_TX_TIMESTAMP_PROVIDER_TIMESTAMP_SIZE); |
| 111 | + } |
| 112 | + while (0); |
| 113 | + |
| 114 | + if (result == false) |
| 115 | + { |
| 116 | + nrf_802154_transmit_done_metadata_t metadata = {}; |
| 117 | + |
| 118 | + metadata.frame_props = p_params->frame_props; |
| 119 | + notify_function(p_frame, NRF_802154_TX_ERROR_TIMESTAMP_ENCODING_ERROR, &metadata); |
| 120 | + } |
| 121 | + |
| 122 | + return result; |
| 123 | +} |
| 124 | + |
| 125 | +bool nrf_802154_tx_timestamp_provider_tx_started_hook(uint8_t * p_frame) |
| 126 | +{ |
| 127 | + NRF_802154_ASSERT(m_tx_timestamp_us == 0); |
| 128 | + |
| 129 | + // Verify that the setup phase has been completed. |
| 130 | + if (mp_tx_timestamp_addr == NULL) |
| 131 | + { |
| 132 | + return true; |
| 133 | + } |
| 134 | + /* This function is executed in the handler of RADIO.ADDRESS event. According to the IPS, |
| 135 | + * in 802.15.4 transmit sequence RADIO.FRAMESTART event is triggered after the SHR is |
| 136 | + * transmitted (nRF52840 PS v1.7 -- 6.20.12.6 Transmit sequence). However, RADIO.ADDRESS |
| 137 | + * event is also triggered in 802.15.4 transmit sequence with a constant 32us offset. |
| 138 | + * This handler is therefore expected to execute 32us before the SHR transmission ends. |
| 139 | + * |
| 140 | + * This function executes approximately 32us before the first bit of PHR. |
| 141 | + * The calculation takes it into account by adding 32us to the current time. |
| 142 | + */ |
| 143 | + m_tx_timestamp_us = nrf_802154_sl_timer_current_time_get() + 32; |
| 144 | + host_64_to_big(m_tx_timestamp_us, mp_tx_timestamp_addr); |
| 145 | + |
| 146 | + mp_tx_timestamp_addr = NULL; |
| 147 | + |
| 148 | + return true; |
| 149 | +} |
| 150 | + |
| 151 | +#endif // NRF_802154_TX_TIMESTAMP_PROVIDER_ENABLED |
0 commit comments