mtp_sap.h

Go to the documentation of this file.

#pragma once
 
/* MTP User SAP description in accordance with ITU Q.701 */
 
/* (C) 2017 by Harald Welte <laforge@gnumonks.org>
 * All Rights Reserved
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 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 General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#include <stdint.h>
#include <osmocom/core/prim.h>
#include <osmocom/sigtran/sigtran_sap.h>
 
enum osmo_mtp_prim_type {
        OSMO_MTP_PRIM_TRANSFER,
        OSMO_MTP_PRIM_PAUSE,
        OSMO_MTP_PRIM_RESUME,
        OSMO_MTP_PRIM_STATUS,
};
extern const struct value_string osmo_mtp_prim_type_names[];
static inline const char *osmo_mtp_prim_type_name(enum osmo_mtp_prim_type val)
{
        return get_value_string(osmo_mtp_prim_type_names, val);
}
 
/* ITU Q.704 14.2 Service information octet. See enum mtp_si_ni00 in mtp.h. */
#define MTP_SIO_EXT(service, net_ind, mp) \
        ((((net_ind) & 0x3) << 6) | \
         (((mp) & 0x3) << 4) | \
         ((service) & 0xf))
#define MTP_SIO(service, net_ind) MTP_SIO_EXT(service, net_ind, 0)
#define MTP_SIO_NI(sio) (((sio) >> 6) & 0x3)
#define MTP_SIO_MP(sio) (((sio) >> 4) & 0x3)
#define MTP_SIO_SI(sio) ((sio) & 0xf)
 
struct osmo_mtp_transfer_param {
        uint32_t opc;
        uint32_t dpc;
        uint8_t sls;
        uint8_t sio;
};
 
struct osmo_mtp_pause_param {
        uint32_t affected_dpc;
};
 
struct osmo_mtp_resume_param {
        uint32_t affected_dpc;
};
 
struct osmo_mtp_status_param {
        uint32_t affected_dpc;
        uint32_t cause; /* enum mtp_unavail_cause */
        bool congestion_level_present;
        uint8_t congestion_level;
};
 
struct osmo_mtp_prim {
        struct osmo_prim_hdr oph;
        union {
                struct osmo_mtp_transfer_param transfer;
                struct osmo_mtp_pause_param pause;
                struct osmo_mtp_resume_param resume;
                struct osmo_mtp_status_param status;
        } u;
};
 
#define msgb_mtp_prim(msg) ((struct osmo_mtp_prim *)(msg)->l1h)
 
char *osmo_mtp_prim_name(const struct osmo_prim_hdr *oph);
 
struct osmo_mtp_prim *osmo_mtp_prim_xfer_req_prepend(const struct osmo_mtp_transfer_param *param,
                                                     struct msgb *msg);