/*
 * Copyright (c) 2017 - 2021, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

/**
 * @brief Module that contains an immediate acknowledgement (Imm-Ack) generator
 * for the 802.15.4 radio driver.
 *
 */

#ifndef NRF_802154_IMM_ACK_GENERATOR_H
#define NRF_802154_IMM_ACK_GENERATOR_H

#include <stdbool.h>
#include <stdint.h>

/** Initializes the Immediate ACK generator module. */
void nrf_802154_imm_ack_generator_init(void);

/** Creates an Immediate ACK in response to the provided frame.
 *
 *  This function creates an Immediate ACK frame and inserts it into a radio buffer.
 *
 * @param [in]  p_frame  Pointer to the buffer that contains PHR and PSDU of the frame
 *                       to respond to.
 *
 * @returns  Pointer to a constant buffer that contains PHR and PSDU of the created
 *           Immediate ACK frame.
 */
const uint8_t * nrf_802154_imm_ack_generator_create(const uint8_t * p_frame);

#endif // NRF_802154_IMM_ACK_GENERATOR_H