/* Header for all NM FSM. Following 3GPP TS 12.21 Figure 2/GSM 12.21:
  GSM 12.21 Objects' Operational state and availability status behaviour during initialization */

/* (C) 2020 by sysmocom - s.m.f.c. GmbH <info@sysmocom.de>
 * Author: Pau Espin Pedrol <pespin@sysmocom.de>
 *
 * All Rights Reserved
 *
 * This program 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.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

#pragma once

#include <osmocom/core/fsm.h>
#include <osmocom/core/utils.h>
#include <osmocom/core/msgb.h>

/* Common */
enum nm_fsm_events {
	NM_EV_SW_ACT,
	NM_EV_SETATTR_ACK, /* data: struct nm_fsm_ev_setattr_data */
	NM_EV_SETATTR_NACK, /* data: struct nm_fsm_ev_setattr_data */
	NM_EV_OPSTART_ACK,
	NM_EV_OPSTART_NACK,
	NM_EV_SHUTDOWN_START,
	NM_EV_SHUTDOWN_FINISH,
	NM_EV_RSL_UP, /* RadioCarrier and BaseBand Transceiver only */
	NM_EV_RSL_DOWN,  /* RadioCarrier and BaseBand Transceiver only */
	NM_EV_PHYLINK_UP, /* RadioCarrier and BaseBand Transceiver only */
	NM_EV_PHYLINK_DOWN,  /* RadioCarrier and BaseBand Transceiver only */
	NM_EV_DISABLE,  /* RadioCarrier and BaseBand Transceiver only */
	NM_EV_BBTRANSC_INSTALLED, /* Radio Channel only */
	NM_EV_BBTRANSC_ENABLED, /* Radio Channel only */
	NM_EV_BBTRANSC_DISABLED, /* Radio Channel only */
	NM_EV_RCARRIER_ENABLED, /* Radio Channel only */
	NM_EV_RCARRIER_DISABLED, /* Radio Channel only */
};
extern const struct value_string nm_fsm_event_names[];

struct nm_fsm_ev_setattr_data {
	struct msgb *msg; /* msgb ownership is transferred to FSM */
	int cause;
};


/* BTS SiteManager */
enum nm_bts_sm_op_fsm_states {
	NM_BTS_SM_ST_OP_DISABLED_NOTINSTALLED,
	NM_BTS_SM_ST_OP_DISABLED_OFFLINE,
	NM_BTS_SM_ST_OP_ENABLED,
};
extern struct osmo_fsm nm_bts_sm_fsm;

/* BTS */
enum nm_bts_op_fsm_states {
	NM_BTS_ST_OP_DISABLED_NOTINSTALLED,
	NM_BTS_ST_OP_DISABLED_OFFLINE,
	NM_BTS_ST_OP_ENABLED,
};
extern struct osmo_fsm nm_bts_fsm;

/* BaseBand Transceiver */
enum nm_bb_transc_op_fsm_states {
	NM_BBTRANSC_ST_OP_DISABLED_NOTINSTALLED,
	NM_BBTRANSC_ST_OP_DISABLED_OFFLINE,
	NM_BBTRANSC_ST_OP_ENABLED,
};
extern struct osmo_fsm nm_bb_transc_fsm;

/* Radio Carrier */
enum nm_rcarrier_op_fsm_states {
	NM_RCARRIER_ST_OP_DISABLED_NOTINSTALLED,
	NM_RCARRIER_ST_OP_DISABLED_OFFLINE,
	NM_RCARRIER_ST_OP_ENABLED,
};
extern struct osmo_fsm nm_rcarrier_fsm;

/* Radio channel */
enum nm_chan_op_fsm_states {
        NM_CHAN_ST_OP_DISABLED_NOTINSTALLED,
        NM_CHAN_ST_OP_DISABLED_DEPENDENCY,
        NM_CHAN_ST_OP_DISABLED_OFFLINE,
        NM_CHAN_ST_OP_ENABLED,
};
extern struct osmo_fsm nm_chan_fsm;