/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * Copyright (C) 2011 Red Hat, Inc.
 *
 * This program is free software: you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation
 *
 * 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/>.
 */

#ifndef LIBWMC_PROTOCOL_H
#define LIBWMC_PROTOCOL_H

#define WMC_CMD_MARKER ((u_int8_t) 0xC8)

enum {
    WMC_CMD_GET_GLOBAL_MODE = 0x03,
    WMC_CMD_SET_GLOBAL_MODE = 0x04,
    WMC_CMD_DEVICE_INFO = 0x06,
    WMC_CMD_IP_INFO = 0x0A,
    WMC_CMD_NET_INFO = 0x0B,
    WMC_CMD_INIT = 0x0D,
    WMC_CMD_SET_OPERATOR = 0x33,
    WMC_CMD_GET_FIRST_OPERATOR = 0x34,
    WMC_CMD_GET_NEXT_OPERATOR = 0x35,
    WMC_CMD_EPS_BEARER_INFO = 0x4D,
};

/* MCC/MNC representation
 *
 * Various commands accept or return an MCC/MNC.  When sending, convert
 * the MCC/MNC into a number using eg. atoi() and store it as an LE 32-bit
 * value.  3-digit MNCs appear to be sent as 3-digit only if the firmware
 * reports them as 3-digit.  For example:
 *
 * T-Mobile US: 310-260
 * mcc_mnc = 0x00007932 = 31026  (note the 2-digit-only MNC)
 *
 * AT&T: 310-410
 * mcc_mnc = 0x0004bc8a = 310410
 */


/* Generic WMC command header */
struct WmcCmdHeader {
    u_int8_t marker;  /* Always 0xC8 */
    u_int8_t cmd;
} __attribute__ ((packed));
typedef struct WmcCmdHeader WmcCmdHeader;

/* Used on newer devices like the UML290 */
struct WmcCmdInit2 {
    WmcCmdHeader hdr;
    u_int8_t _unknown1[14];
} __attribute__ ((packed));
typedef struct WmcCmdInit2 WmcCmdInit2;

struct WmcCmdInit2Rsp {
    WmcCmdHeader hdr;
    u_int8_t _unknown1[4];
} __attribute__ ((packed));
typedef struct WmcCmdInit2Rsp WmcCmdInit2Rsp;

struct WmcCmdDeviceInfoRsp {
    WmcCmdHeader hdr;
    u_int8_t _unknown1[27];
    char     manf[64];
    char     model[64];
    char     fwrev[64];
    char     hwrev[64];
    u_int8_t _unknown2[64];
    u_int8_t _unknown3[64];
    u_int8_t _unknown4[22];
    u_int8_t _unknown5[8];
    u_int8_t _unknown6[6];
} __attribute__ ((packed));
typedef struct WmcCmdDeviceInfoRsp WmcCmdDeviceInfoRsp;

struct WmcCmdDeviceInfo2Rsp {
    WmcCmdHeader hdr;
    u_int8_t _unknown1[27];
    char     manf[64];
    char     model[64];
    char     fwrev[64];
    char     hwrev[64];
    u_int8_t _unknown2[64];
    u_int8_t _unknown3[64];
    u_int8_t min[10];       /* CDMA2000/IS-95 MIN */
    u_int8_t _unknown4[12];
    u_int16_t home_sid;     /* ? */
    u_int8_t _unknown5[6];
    u_int16_t eri_ver;      /* ? */
    u_int8_t _unknown6[3];
    u_int8_t _unknown7[64];
    u_int8_t meid[20];
    u_int8_t imei[22];
    u_int8_t _unknown9[16];
    u_int8_t iccid[22];
    u_int8_t _unknown10[4];
    u_int8_t mcc[16];
    u_int8_t mnc[16];
    u_int8_t _unknown11[4];
    u_int8_t _unknown12[4];
    u_int8_t _unknown13[4];
} __attribute__ ((packed));
typedef struct WmcCmdDeviceInfo2Rsp WmcCmdDeviceInfo2Rsp;

/*****************************************************/

enum {
    WMC_SERVICE_NONE = 0,
    WMC_SERVICE_AMPS = 1,
    WMC_SERVICE_IS95A = 2,
    WMC_SERVICE_IS95B = 3,
    WMC_SERVICE_GSM = 4,
    WMC_SERVICE_GPRS = 5,
    WMC_SERVICE_1XRTT = 6,
    WMC_SERVICE_EVDO_0 = 7,
    WMC_SERVICE_UMTS = 8,
    WMC_SERVICE_EVDO_A = 9,
    WMC_SERVICE_EDGE = 10,
    WMC_SERVICE_HSDPA = 11,
    WMC_SERVICE_HSUPA = 12,
    WMC_SERVICE_HSPA = 13,
    WMC_SERVICE_LTE = 14
};

/* PC5740 response */
struct WmcCmdNetworkInfoRsp {
    WmcCmdHeader hdr;
    u_int8_t  _unknown1;
    u_int8_t  _unknown2[3];    /* Always zero */
    u_int8_t  service;         /* One of WMC_SERVICE_* */
    u_int8_t  _unknown4;       /* Either 0x00 or 0x01 */
    u_int8_t  magic[10];
    u_int16_t counter1;        /* A timestamp/counter? */
    u_int8_t  _unknown5;
    u_int8_t  _unknown6;
    u_int8_t  _unknown7[3];    /* Always 0xFE 0xFF 0xFF */
    u_int8_t  two_g_dbm;       /* 0x7D = no signal */
    u_int8_t  _unknown8[37];   /* Always zero */
} __attribute__ ((packed));
typedef struct WmcCmdNetworkInfoRsp WmcCmdNetworkInfoRsp;

/* UML190 response */
struct WmcCmdNetworkInfo2Rsp {
    WmcCmdHeader hdr;
    u_int8_t  _unknown1;       /* 0x00 on LTE, 0x07 or 0x1F on CDMA */
    u_int8_t  _unknown2[3];    /* Always zero */
    u_int8_t  service;         /* One of WMC_SERVICE_* */
    u_int8_t  _unknown4;
    u_int8_t  magic[10];       /* Whatever was passed in WMC_CMD_INIT with some changes */
    u_int16_t counter1;        /* A timestamp/counter? */
    u_int16_t counter2;        /* Time since firmware start? */
    u_int8_t  _unknown5;       /* 0x00 on LTE, various values (0xD4, 0x5C) on CDMA */
    u_int8_t  _unknown6[3];    /* always zero on LTE, 0xFE 0xFF 0xFF on CDMA */
    u_int8_t  two_g_dbm;       /* 0x7D = no CDMA signal, 0x6a = no GSM signal */
    u_int8_t  _unknown7[3];    /* Always zero */
    u_int8_t  cdma_opname[16]; /* Zero terminated? */
    u_int8_t  _unknown8[18];   /* Always zero */
    u_int8_t  three_g_dbm;     /* 0x7D = no signal */
    u_int8_t  _unknown9[3];    /* Always zero */
    u_int8_t  _unknown10;      /* 0x01 on LTE, 0x40 on CDMA */
    u_int8_t  _unknown11[3];   /* Always zero */
    u_int8_t  _unknown12;      /* Always 0x01 */
    u_int8_t  tgpp_opname[8];  /* 3GPP operator name (Zero terminated? Sometimes "MCC MNC" too */
    u_int8_t  _unknown13[4];   /* Always zero */
    u_int32_t _unknown14;      /* 43 75 3a 00 on GSM/WCDMA mode, zero on others  */
    u_int32_t _unknown15;      /* 49 7d 3a 00 on GSM/WCDMA mode, zero on others  */
    u_int8_t  _unknown16[44];  /* Always zero */
    u_int32_t mcc_mnc;         /* GSM/WCDMA only, see MCC/MNC format note */
} __attribute__ ((packed));
typedef struct WmcCmdNetworkInfo2Rsp WmcCmdNetworkInfo2Rsp;

/* UML290 response */
struct WmcCmdNetworkInfo3Rsp {
    WmcCmdHeader hdr;
    u_int8_t  _unknown1;       /* 0x00 on LTE, 0x07 or 0x1F on CDMA */
    u_int8_t  _unknown2[3];    /* Always zero */
    u_int8_t  service;         /* One of WMC_SERVICE_* */
    u_int8_t  _unknown4;
    u_int8_t  magic[10];       /* Whatever was passed in WMC_CMD_INIT with some changes */
    u_int16_t counter1;        /* A timestamp/counter? */
    u_int16_t counter2;        /* Time since firmware start? */
    u_int8_t  _unknown5;       /* 0x00 on LTE, various values (0xD4, 0x5C) on CDMA */
    u_int8_t  _unknown6[3];    /* always zero on LTE, 0xFE 0xFF 0xFF on CDMA */
    u_int8_t  two_g_dbm;       /* 0x7D = no CDMA signal, 0x6a = no GSM signal */
    u_int8_t  _unknown7[3];    /* Always zero */
    u_int8_t  cdma_opname[16]; /* Zero terminated? */
    u_int8_t  _unknown8[18];   /* Always zero */
    u_int8_t  three_g_dbm;     /* 0x7D = no signal */
    u_int8_t  _unknown9[3];    /* Always zero */
    u_int8_t  _unknown10;      /* 0x01 on LTE, 0x40 on CDMA */
    u_int8_t  _unknown11[3];   /* Always zero */
    u_int8_t  _unknown12;      /* Always 0x01 */
    u_int8_t  tgpp_opname[8];   /* Zero terminated? Sometimes "MCC MNC" too */
    u_int8_t  _unknown13[4];   /* Always zero */
    u_int32_t _unknown14;      /* 43 75 3a 00 on GSM/WCDMA mode, zero on others  */
    u_int32_t _unknown15;      /* 49 7d 3a 00 on GSM/WCDMA mode, zero on others  */
    u_int8_t  _unknown16[44];  /* Always zero */
    u_int32_t mcc_mnc;         /* GSM/WCDMA only, see MCC/MNC format note */
    u_int8_t  lte_dbm;         /* 0x00 if not in LTE mode */
    u_int8_t  _unknown17[3];   /* Always zero */
    u_int8_t  _unknown18[4];
} __attribute__ ((packed));
typedef struct WmcCmdNetworkInfo3Rsp WmcCmdNetworkInfo3Rsp;

/*****************************************************/

struct WmcCmdConnectionInfoRsp {
    WmcCmdHeader hdr;
    u_int32_t rx_bytes;
    u_int32_t tx_bytes;
    u_int8_t  _unknown3[8];
    u_int8_t  _unknown4;       /* Either 0x01, 0x02, 0x03, or 0x04 */
    u_int8_t  _unknown5[7];    /* Always 0xc0 0x0b 0x00 0x01 0x00 0x00 0x00 */
    u_int8_t  ip4_address[16]; /* String format, ie "10.156.45.3" */
    u_int8_t  _unknown6[8];    /* Netmask? */
    u_int8_t  ip6_address[40]; /* String format */
} __attribute__ ((packed));
typedef struct WmcCmdConnectionInfoRsp WmcCmdConnectionInfoRsp;

/*****************************************************/

enum {
    WMC_GLOBAL_MODE_CDMA      = 0x00,
    WMC_GLOBAL_MODE_GSM_AUTO  = 0x0A,
    WMC_GLOBAL_MODE_GPRS_ONLY = 0x0B,
    WMC_GLOBAL_MODE_UMTS_ONLY = 0x0C,
    WMC_GLOBAL_MODE_AUTO      = 0x14,
};

struct WmcCmdGetGlobalMode {
    WmcCmdHeader hdr;
    u_int8_t _unknown1;  /* always 0 */
} __attribute__ ((packed));
typedef struct WmcCmdGetGlobalMode WmcCmdGetGlobalMode;

struct WmcCmdGetGlobalModeRsp {
    WmcCmdHeader hdr;
    u_int8_t _unknown1;  /* always 0x01 */
    u_int8_t mode;       /* one of WMC_GLOBAL_MODE_* */
    u_int8_t _unknown2;  /* always 0x05 */
    u_int8_t _unknown3;  /* always 0x00 */
} __attribute__ ((packed));
typedef struct WmcCmdGetGlobalModeRsp WmcCmdGetGlobalModeRsp;

/*****************************************************/

struct WmcCmdSetGlobalMode {
    WmcCmdHeader hdr;
    u_int8_t _unknown1;  /* always 0x01 */
    u_int8_t mode;       /* one of WMC_GLOBAL_MODE_* */
    u_int8_t _unknown2;  /* always 0x05 */
    u_int8_t _unknown3;  /* always 0x00 */
} __attribute__ ((packed));
typedef struct WmcCmdSetGlobalMode WmcCmdSetGlobalMode;

struct WmcCmdSetGlobalModeRsp {
    WmcCmdHeader hdr;
    u_int8_t _unknown1;   /* always 0x01 */
    u_int32_t _unknown2;  /* always zero */
} __attribute__ ((packed));
typedef struct WmcCmdSetGlobalModeRsp WmcCmdSetGlobalModeRsp;

/*****************************************************/

struct WmcCmdSetOperator {
    WmcCmdHeader hdr;
    u_int8_t automatic;      /* 0x00 = manual, 0x01 = auto */
    u_int8_t _unknown1;      /* always 0x50 */
    u_int8_t _unknown2[3];   /* always zero */
    u_int32_t mcc_mnc;       /* MCC/MNC for manual reg (see format note), zero for auto */
    u_int8_t _unknown3[56];  /* always zero */
} __attribute__ ((packed));
typedef struct WmcCmdSetOperator WmcCmdSetOperator;

enum {
    WMC_SET_OPERATOR_STATUS_OK = 0,
    WMC_SET_OPERATOR_STATUS_REGISTERING = 0x63,
    WMC_SET_OPERATOR_STATUS_FAILED = 0x68,
};

struct WmcCmdSetOperatorRsp {
    WmcCmdHeader hdr;
    u_int8_t status;        /* one of WMC_SET_OPERATOR_STATUS_* */
    u_int8_t _unknown1[3];  /* always zero */
} __attribute__ ((packed));
typedef struct WmcCmdSetOperatorRsp WmcCmdSetOperatorRsp;

/*****************************************************/

enum {
    WMC_OPERATOR_SERVICE_UNKNOWN = 0,
    WMC_OPERATOR_SERVICE_GSM = 1,
    WMC_OPERATOR_SERVICE_UMTS = 2,
};

/* Response for both GET_FIRST_OPERATOR and GET_NEXT_OPERATOR */
struct WmcCmdGetOperatorRsp {
    WmcCmdHeader hdr;
    u_int8_t  _unknown1;     /* Usually 0x50, sometimes 0x00 */
    u_int8_t  _unknown2[3];  /* always zero */
    u_int32_t mcc_mnc;       /* see format note */
    u_int8_t  opname[8];
    u_int8_t  _unknown3[56]; /* always zero */
    u_int8_t  stat;          /* follows 3GPP TS27.007 +COPS <stat> ? */
    u_int8_t  _unknown4[3];  /* always zero */
    u_int8_t  service;       /* one of WMC_OPERATOR_SERVICE_* */
    u_int8_t  _unknown5[3];  /* always zero */
    u_int8_t  _unknown6;     /* 0x63 (GET_FIRST_OP) might mean "wait" */
    u_int8_t  _unknown7;     /* 0x00 or 0x01 */
    u_int8_t  _unknown8[2];  /* always zero */
} __attribute__ ((packed));
typedef struct WmcCmdSetOperatorRsp WmcCmdSetOperatorRsp;

/*****************************************************/

#endif  /* LIBWMC_PROTOCOL_H */