srsLTE/srsue/hdr/stack/upper/nas_emm_state.h

/**
 *
 * \section COPYRIGHT
 *
 * Copyright 2013-2020 Software Radio Systems Limited
 *
 * By using this file, you agree to the terms and conditions set
 * forth in the LICENSE file which can be found at the top level of
 * the distribution.
 *
 */

#ifndef SRSUE_NAS_EMM_STATE_H
#define SRSUE_NAS_EMM_STATE_H

#include "srslte/srslog/srslog.h"
#include <atomic>
#include <string>

namespace srsue {

// EMM states (3GPP 24.302 v14.0.0)
class emm_state_t
{
public:
  enum class state_t {
    null = 0,
    deregistered,
    deregistered_initiated,
    registered,
    registered_initiated,
    tau_initiated,
    service_request_initiated,
  };

  // EMM-DEREGISTERED sub-states (3GPP 24.302 v14.0.0)
  enum class deregistered_substate_t {
    null = 0, // This should be used when not in EMM-DEREGISTERED
    normal_service,
    limited_service,
    attempting_to_attach,
    plmn_search,
    no_imsi,
    attach_needed,
    no_cell_available,
    e_call_inactive,
  };

  // EMM-REGISTERED sub-states (3GPP 24.302 v14.0.0)
  enum class registered_substate_t {
    null = 0, // This should be used when not in EMM-REGISTERED
    normal_service,
    attempting_to_update,
    limited_service,
    plmn_search,
    update_needed,
    no_cell_available,
    attempting_to_update_mm,
    imsi_dettach_initiated,
  };

  // FSM setters
  void set_null();
  void set_deregistered(deregistered_substate_t substate);
  void set_deregistered_initiated();
  void set_registered(registered_substate_t substate);
  void set_registered_initiated();
  void set_tau_initiated();
  void set_service_request_initiated();

  // FSM getters
  state_t                 get_state() { return state; }
  deregistered_substate_t get_deregistered_substate() { return deregistered_substate; }
  registered_substate_t   get_registered_substate() { return registered_substate; }

  // Text Helpers
  const std::string get_full_state_text();

private:
  std::atomic<state_t>    state{state_t::null}; // The GW might require to know the NAS state from another thread
  deregistered_substate_t deregistered_substate = deregistered_substate_t::null;
  registered_substate_t   registered_substate   = registered_substate_t::null;
  srslog::basic_logger&   logger                = srslog::fetch_basic_logger("NAS");
};

const char* emm_state_text(emm_state_t::state_t type);
const char* emm_deregistered_substate_text(emm_state_t::deregistered_substate_t type);
const char* emm_registered_substate_text(emm_state_t::registered_substate_t type);

} // namespace srsue
#endif