1 /*
2  * Copyright (c) 2021 - 2023, 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  * @brief Module that provides work buffer for transmissions.
37  *
38  * This module performs the following functions:
39  *  - stores properties of the frame to be transmitted
40  *  - optionally provides an additional work buffer to modify frame data without affecting
41  *    the original frame's contents
42  *
43  * By default, the using of work buffer is turned off. If desired, it can be turned on with
44  * @ref nrf_802154_tx_work_buffer_enable_for.
45  *
46  */
47 
48 #ifndef NRF_802154_TX_WORK_BUFFER_H_
49 #define NRF_802154_TX_WORK_BUFFER_H_
50 
51 #include <stdint.h>
52 #include <stdbool.h>
53 
54 #include "nrf_802154_types.h"
55 
56 /**
57  * @brief Resets work buffer.
58  *
59  * Internal state of the work buffer is completely reset after this call.
60  * If @p p_frame_props is not NULL, the work buffer properties are set according to the contents
61  * of the given structure.
62  *
63  * @param[in]  p_frame_props  Pointer to a structure containing the initial properties that will
64  *                            be set for the work buffer.
65  */
66 void nrf_802154_tx_work_buffer_reset(const nrf_802154_transmitted_frame_props_t * p_frame_props);
67 
68 /**
69  * @brief Enables work buffer for provided frame.
70  *
71  * In order to avoid performing potentially hazardous operations on the original buffer containing
72  * data to be transmitted, a work buffer can be allocated to the original frame. After all necessary
73  * modifications are performed on the work buffer, its contents can be copied back to the original
74  * buffer so that its state is always well-defined.
75  *
76  * @pre Before enabling the work buffer must be initialized with @ref nrf_802154_tx_work_buffer_reset
77  *
78  * @param[in]  p_original_frame  Pointer to the original frame to be transmitted.
79  *
80  * @returns  Pointer to a work buffer bound to @p p_original_frame.
81  */
82 uint8_t * nrf_802154_tx_work_buffer_enable_for(uint8_t * p_original_frame);
83 
84 /**
85  * @brief Gets buffer to be transmitted.
86  *
87  * Depending on whether @p p_original_frame has a work buffer bound, this function either returns
88  * that work buffer or the original frame, if no such binding exists.
89  *
90  * @param[in]  p_original_frame  Pointer to the original frame to be transmitted.
91  *
92  * @returns  Pointer to a buffer to be transmitted.
93  */
94 const uint8_t * nrf_802154_tx_work_buffer_get(const uint8_t * p_original_frame);
95 
96 /**
97  * @brief Updates the original buffer with its bound work buffer contents.
98  *
99  * Processing performed on the work buffer might require copying its contents back to the original
100  * buffer. This function performs all necessary updates of the original buffer in place.
101  *
102  * @param[inout]    p_original_frame    Pointer to the original frame to be transmitted.
103  * @param[out]      p_frame_props       Pointer to a structure to which properties of the frame
104  *                                      to be transmitted are stored.
105  */
106 void nrf_802154_tx_work_buffer_original_frame_update(
107     uint8_t                              * p_original_frame,
108     nrf_802154_transmitted_frame_props_t * p_frame_props);
109 
110 /**
111  * @brief Marks a work buffer as secured.
112  */
113 void nrf_802154_tx_work_buffer_is_secured_set(void);
114 
115 /**
116  * @brief Marks a work buffer as containing updated dynamic data.
117  */
118 void nrf_802154_tx_work_buffer_is_dynamic_data_updated_set(void);
119 
120 /**
121  * @brief Sets offset of encryption plain text for the work buffer.
122  *
123  * @param[in]  offset  Offset of encryption plain text to be set.
124  */
125 void nrf_802154_tx_work_buffer_plain_text_offset_set(uint8_t offset);
126 
127 #endif // NRF_802154_TX_WORK_BUFFER_H_
128