srsLTE/lib/include/srslte/upper/pdcp.h

/*
 * Copyright 2013-2019 Software Radio Systems Limited
 *
 * This file is part of srsLTE.
 *
 * srsLTE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsLTE is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */

#ifndef SRSLTE_PDCP_H
#define SRSLTE_PDCP_H

#include "srslte/common/common.h"
#include "srslte/common/log.h"
#include "srslte/interfaces/ue_interfaces.h"
#include "srslte/upper/pdcp_entity_lte.h"

namespace srslte {

class pdcp : public srsue::pdcp_interface_rlc, public srsue::pdcp_interface_rrc
{
public:
  pdcp(srslte::timer_handler* timers_, log* log_);
  virtual ~pdcp();
  void init(srsue::rlc_interface_pdcp* rlc_, srsue::rrc_interface_pdcp* rrc_, srsue::gw_interface_pdcp* gw_);
  void stop();

  // GW interface
  bool is_lcid_enabled(uint32_t lcid);

  // RRC interface
  void reestablish();
  void reestablish(uint32_t lcid);
  void reset();
  void write_sdu(uint32_t lcid, unique_byte_buffer_t sdu, bool blocking);
  void write_sdu_mch(uint32_t lcid, unique_byte_buffer_t sdu);
  void add_bearer(uint32_t lcid, pdcp_config_t cnfg);
  void add_bearer_mrb(uint32_t lcid, pdcp_config_t cnfg);
  void del_bearer(uint32_t lcid);
  void change_lcid(uint32_t old_lcid, uint32_t new_lcid);
  void config_security(uint32_t                    lcid,
                       uint8_t*                    k_rrc_enc,
                       uint8_t*                    k_rrc_int,
                       uint8_t*                    k_up_enc,
                       CIPHERING_ALGORITHM_ID_ENUM cipher_algo,
                       INTEGRITY_ALGORITHM_ID_ENUM integ_algo);
  void config_security_all(uint8_t*                    k_rrc_enc,
                           uint8_t*                    k_rrc_int,
                           uint8_t*                    k_up_enc,
                           CIPHERING_ALGORITHM_ID_ENUM cipher_algo,
                           INTEGRITY_ALGORITHM_ID_ENUM integ_algo);
  void enable_integrity(uint32_t lcid, srslte_direction_t direction);
  void enable_encryption(uint32_t lcid, srslte_direction_t direction);
  bool get_bearer_status(uint32_t lcid, uint16_t* dlsn, uint16_t* dlhfn, uint16_t* ulsn, uint16_t* ulhfn);

  // RLC interface
  void write_pdu(uint32_t lcid, unique_byte_buffer_t sdu);
  void write_pdu_mch(uint32_t lcid, unique_byte_buffer_t sdu);
  void write_pdu_bcch_bch(unique_byte_buffer_t sdu);
  void write_pdu_bcch_dlsch(unique_byte_buffer_t sdu);
  void write_pdu_pcch(unique_byte_buffer_t sdu);

private:
  srsue::rlc_interface_pdcp* rlc = nullptr;
  srsue::rrc_interface_pdcp* rrc = nullptr;
  srsue::gw_interface_pdcp*  gw  = nullptr;

  typedef std::map<uint16_t, pdcp_entity_lte*>  pdcp_map_t;
  typedef std::pair<uint16_t, pdcp_entity_lte*> pdcp_map_pair_t;

  srslte::timer_handler* timers   = nullptr;
  log*                   pdcp_log = nullptr;
  pdcp_map_t             pdcp_array, pdcp_array_mrb;
  pthread_rwlock_t       rwlock;

  bool valid_lcid(uint32_t lcid);
  bool valid_mch_lcid(uint32_t lcid);
};

} // namespace srslte
#endif // SRSLTE_PDCP_H