nrf_802154_ack_data.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017, 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.
 *
 */
 
#ifndef NRF_802154_ACK_DATA_H
#define NRF_802154_ACK_DATA_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "nrf_802154_types.h"
#include "mac_features/nrf_802154_frame.h"
 
typedef struct
{
    uint8_t data[NRF_802154_MAX_ACK_IE_SIZE]; 
    uint8_t len;                              
} nrf_802154_peer_ie_data_t;
 
typedef struct
{
    bool                      pending_bit : 1;
    nrf_802154_peer_ie_data_t ie_data;
} nrf_802154_peer_rec_t;
 
void nrf_802154_ack_data_init(void);
 
void nrf_802154_ack_data_enable(bool enabled);
 
bool nrf_802154_peer_rec_get(const uint8_t         * p_addr,
                             bool                    extended,
                             nrf_802154_peer_rec_t * p_peer_rec);
 
bool nrf_802154_peer_rec_write(const uint8_t               * p_addr,
                               bool                          extended,
                               const nrf_802154_peer_rec_t * p_peer_rec);
 
bool nrf_802154_peer_rec_delete(const uint8_t * p_addr,
                                bool            extended);
 
void nrf_802154_peer_table_clear(bool extended);
 
bool nrf_802154_ack_data_for_addr_set(const uint8_t       * p_addr,
                                      bool                  extended,
                                      nrf_802154_ack_data_t data_type,
                                      const void          * p_data,
                                      uint8_t               data_len);
 
bool nrf_802154_ack_data_for_addr_clear(const uint8_t       * p_addr,
                                        bool                  extended,
                                        nrf_802154_ack_data_t data_type);
 
void nrf_802154_ack_data_reset(bool extended, nrf_802154_ack_data_t data_type);
 
void nrf_802154_ack_data_src_addr_matching_method_set(nrf_802154_src_addr_match_t match_method);
 
bool nrf_802154_ack_data_pending_bit_should_be_set(const nrf_802154_frame_t    * p_frame_data,
                                                   const nrf_802154_peer_rec_t * p_peer_rec);
 
#endif /* NRF_802154_ACK_DATA_H */