proto.h

Go to the documentation of this file.

 
/* (C) 2019 by Sylvain Munaut <tnt@246tNt.com>
 * (C) 2020 by Harald Welte <laforge@gnumonks.org>
 *
 * All Rights Reserved
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser 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 Lesser General Public License
 * along with this program; if not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <stdint.h>
 
#include <osmocom/core/select.h>
#include <osmocom/core/utils.h>
 
 
enum osmo_e1dp_msg_type {
        E1DP_CMD_INTF_QUERY     = 0x00,
 
        E1DP_CMD_LINE_QUERY     = 0x01,
 
        E1DP_CMD_TS_QUERY       = 0x02,
 
        E1DP_CMD_LINE_CONFIG    = 0x03,
 
        E1DP_CMD_TS_OPEN        = 0x04,
 
        E1DP_CMD_SABITS         = 0x05,
 
        E1DP_CMD_CAS            = 0x06,
 
        E1DP_EVT_LOS_ON         = 0x40,
 
        E1DP_EVT_LOS_OFF        = 0x41,
 
        E1DP_EVT_AIS_ON         = 0x42,
 
        E1DP_EVT_AIS_OFF        = 0x43,
 
        E1DP_EVT_RAI_ON         = 0x44,
 
        E1DP_EVT_RAI_OFF        = 0x45,
 
        E1DP_EVT_LOF_ON         = 0x46,
 
        E1DP_EVT_LOF_OFF        = 0x47,
 
        E1DP_EVT_CAS            = 0x7e,
 
        E1DP_EVT_SABITS         = 0x7f,
 
        E1DP_EVT_TYPE           = 0x40,
        E1DP_RESP_TYPE          = 0x80,
        E1DP_ERR_TYPE           = 0xc0,
        E1DP_TYPE_MSK           = 0xc0,
};
 
enum osmo_e1dp_line_mode {
        E1DP_LMODE_OFF          = 0x00,
        E1DP_LMODE_CHANNELIZED  = 0x20,
        E1DP_LMODE_SUPERCHANNEL = 0x21,
        E1DP_LMODE_E1OIP        = 0x22,
};
 
enum osmo_e1dp_ts_mode {
        E1DP_TSMODE_OFF         = 0x00,
        E1DP_TSMODE_RAW         = 0x10,
        E1DP_TSMODE_HDLCFCS     = 0x11,
};
 
#define E1DP_TS_OPEN_F_FORCE    0x80
 
#define E1DP_MAGIC      0x01e1
#define E1DP_MAX_LEN    4096
#define E1DP_TS_SUPERCHAN 0xfe
#define E1DP_INVALID    0xff
#define E1DP_DEFAULT_SOCKET "/tmp/osmo-e1d.ctl"
 
#define E1DP_MAX_SIZE_HDLC      264
 
struct osmo_e1dp_msg_hdr {
        uint16_t magic;         /*< magic value (E1DP_MAGIC) */
        uint16_t len;           /*< length of message (octets) */
 
        uint8_t  type;          /*< message type (enum osmo_e1dp_msg_type) */
        uint8_t  intf;          /*< E1 interface number (or E1DP_INVALID) */
        uint8_t  line;          /*< E1 line number (or E1DP_INVALID) */
        uint8_t  ts;            /*< timeslot number (or E1DP_INVALID) */
} __attribute__((packed));
 
struct osmo_e1dp_intf_info {
        uint8_t id;             /*< Numeric identifier of E1 interface */
        uint8_t n_lines;        /*< number of E1 lines within this interface */
} __attribute__((packed));
 
struct osmo_e1dp_line_config {
        uint8_t mode;           /*< E1 line mode (enum osmo_e1dp_line_mode) */
} __attribute__((packed));
 
struct osmo_e1dp_line_info {
        uint8_t id;                             /*< E1 line number */
        struct osmo_e1dp_line_config cfg;       
        uint8_t status;                         
} __attribute__((packed));
 
struct osmo_e1dp_ts_config {
        uint8_t mode;           /*< timeslot mode (enum osmo_e1dp_ts_mode) */
        uint8_t flags;          /*< flags (currently only E1DP_TS_OPEN_F_FORCE) */
        uint16_t read_bufsize;  /*< size of read buffer (in octets) */
} __attribute__((packed));
 
struct osmo_e1dp_ts_info {
        uint8_t id;                             /*< E1 timeslot number */
        struct osmo_e1dp_ts_config cfg;         /*< E1 timeslot configuration */
        uint8_t status;                         /*< TBD */
} __attribute__((packed));
 
struct osmo_e1dp_cas_bits {
        uint8_t bits;                           /*< CAS value */
        uint8_t query_rx;                       /*< set to 1, to query RX CAS information */
} __attribute__((packed));
 
 
struct msgb *osmo_e1dp_recv(struct osmo_fd *ofd, int *fd);
int osmo_e1dp_send(struct osmo_fd *ofd, struct msgb *msgb, int fd);
 
extern const struct value_string osmo_e1dp_msg_type_names[];
extern const struct value_string osmo_e1dp_line_mode_names[];
extern const struct value_string osmo_e1dp_ts_mode_names[];