Robert Schmidt
6ae4ec37ca
Remove the \file directive, as it is always superfluous because the current file is implicit [1]: > If the file name is omitted (i.e. the line after \file is left blank) > then the documentation block that contains the \file command will belong > to the file it is located in. Author names and e-mails are not relevant for us: it can always be inferred from git blame, and is often outdated. Eurecom code has been contributed and was under OAI PL v1.0/v1.1. For the cpack package contact: put generic email address that is independent of an individual and that will remain reachable. [1] https://www.doxygen.nl/manual/commands.html#cmdfile
67 lines
2.4 KiB
C
67 lines
2.4 KiB
C
/*
|
|
* Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership.
|
|
* The OpenAirInterface Software Alliance licenses this file to You under
|
|
* the OAI Public License, Version 1.1 (the "License"); you may not use this file
|
|
* except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.openairinterface.org/?page_id=698
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*-------------------------------------------------------------------------------
|
|
* For more information about the OpenAirInterface (OAI) Software Alliance:
|
|
* contact@openairinterface.org
|
|
*/
|
|
|
|
/*!
|
|
* \brief PDCP Sequence Numbering Methods
|
|
*/
|
|
|
|
#ifndef PDCP_SEQUENCE_MANAGER_H
|
|
#define PDCP_SEQUENCE_MANAGER_H
|
|
|
|
#include "pdcp.h"
|
|
|
|
/**
|
|
* Initializes sequence numbering state
|
|
* @param pdcp_entity The PDCP entity to be initialized
|
|
* @return none
|
|
*/
|
|
bool pdcp_init_seq_numbers(pdcp_t* pdcp_entity);
|
|
/**
|
|
* Checks if incoming PDCP entitiy pointer and relevant sequence number size is valid
|
|
* @return true (0x01) if it is valid, false (0x00) otherwise
|
|
*/
|
|
bool pdcp_is_seq_num_size_valid(pdcp_t* pdcp_entity);
|
|
/**
|
|
* Check if SN number is in the range according to SN size
|
|
* @return true if it is valid, false otherwise
|
|
*/
|
|
bool pdcp_is_seq_num_valid(uint16_t seq_num, uint8_t seq_num_size);
|
|
/**
|
|
* Returns the maximum allowed sequence number value for given size of SN field
|
|
* @return Max sequence number value
|
|
*/
|
|
uint16_t pdcp_calculate_max_seq_num_for_given_size(uint8_t seq_num_size);
|
|
/**
|
|
* Returns the next TX sequence number for given PDCP entity
|
|
*/
|
|
uint16_t pdcp_get_next_tx_seq_number(pdcp_t* pdcp_entity);
|
|
/**
|
|
* Advances the RX window state of given PDCP entity upon successfull receipt of a SDU
|
|
*/
|
|
bool pdcp_advance_rx_window(pdcp_t* pdcp_entity);
|
|
/**
|
|
* Updates missing PDU bitmap with incoming sequence number
|
|
* @return true if successful, false otherwise
|
|
*/
|
|
bool pdcp_mark_current_pdu_as_received(uint16_t seq_num, pdcp_t* pdcp_entity);
|
|
|
|
#endif
|