/* packet-mac-lte.h
 *
 * Martin Mathieson
 * $Id: packet-mac-lte.h 42240 2012-04-25 20:02:12Z pascal $
 *
 * Wireshark - Network traffic analyzer
 * By Gerald Combs <gerald@wireshark.org>
 * Copyright 1998 Gerald Combs
 *
 * This header file may also be distributed under
 * the terms of the BSD Licence as follows:
 *
 * Copyright (C) 2009 Martin Mathieson. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE
 */

#ifndef PACKET_MAC_LTE_H_
#define PACKET_MAC_LTE_H_

/* radioType */
#define FDD_RADIO 1
#define TDD_RADIO 2

/* Direction */
#define DIRECTION_UPLINK   0
#define DIRECTION_DOWNLINK 1

/* SR: no need to declare following part: */
typedef enum mac_lte_oob_event {
  ltemac_send_preamble,
  ltemac_send_sr,
  ltemac_sr_failure
} mac_lte_oob_event;

typedef enum mac_lte_dl_retx {
  dl_retx_no,
  dl_retx_yes,
  dl_retx_unknown
} mac_lte_dl_retx;

typedef enum mac_lte_crc_status {
  crc_fail = 0,
  crc_success = 1,
  crc_high_code_rate = 2,
  crc_pdsch_lost = 3,
  crc_duplicate_nonzero_rv = 4
} mac_lte_crc_status;

/* Context info attached to each LTE MAC frame */
typedef struct mac_lte_info {
  /* Needed for decode */
  guint8          radioType;
  guint8          direction;
  guint8          rntiType;

  /* Extra info to display */
  guint16         rnti;
  guint16         ueid;

  /* Timing info */
  guint16         sysframeNumber;
  guint16         subframeNumber;

  /* Optional field. More interesting for TDD (FDD is always -4 subframeNumber) */
  gboolean        subframeNumberOfGrantPresent;
  guint16         subframeNumberOfGrant;

  /* Flag set only if doing PHY-level data test - i.e. there may not be a
     well-formed MAC PDU so just show as raw data */
  gboolean        isPredefinedData;

  /* Length of DL PDU or UL grant size in bytes */
  guint16         length;

  /* UL only.  0=newTx, 1=first-retx, etc */
  guint8          reTxCount;
  guint8          isPHICHNACK; /* FALSE=PDCCH retx grant, TRUE=PHICH NACK */

  /* UL only.  Indicates if the R10 extendedBSR-Sizes parameter is set */
  gboolean        isExtendedBSRSizes;

  /* DL only.  Status of CRC check */
  mac_lte_crc_status   crcStatusValid;

  /* DL only.  Is this known to be a retransmission? */
  mac_lte_dl_retx dl_retx;

  /* More Physical layer info (see direction above for which side of union to use) */
  union {
    struct mac_lte_ul_phy_info {
      guint8 present;  /* Remaining UL fields are present and should be displayed */
      guint8 modulation_type;
      guint8 tbs_index;
      guint8 resource_block_length;
      guint8 resource_block_start;
      guint8 harq_id;
      gboolean ndi;
    } ul_info;
    struct mac_lte_dl_phy_info {
      guint8 present; /* Remaining UL fields are present and should be displayed */
      guint8 dci_format;
      guint8 resource_allocation_type;
      guint8 aggregation_level;
      guint8 mcs_index;
      guint8 redundancy_version_index;
      guint8 resource_block_length;
      mac_lte_crc_status crc_status;
      guint8 harq_id;
      gboolean ndi;
      guint8   transport_block;  /* 1..2 */
    } dl_info;
  } detailed_phy_info;

  /* Relating to out-of-band events */
  /* N.B. dissector will only look to these fields if length is 0... */
  mac_lte_oob_event  oob_event;
  guint8             rapid;
  guint8             rach_attempt_number;
#define MAX_SRs 20
  guint16            number_of_srs;
  guint16            oob_ueid[MAX_SRs];
  guint16            oob_rnti[MAX_SRs];
} mac_lte_info;

/* Accessor function to check if a frame was considered to be ReTx */
//int is_mac_lte_frame_retx(packet_info *pinfo, guint8 direction);

/*****************************************************************/
/* UDP framing format                                            */
/* -----------------------                                       */
/* Several people have asked about dissecting MAC by framing     */
/* PDUs over IP.  A suggested format over UDP has been created   */
/* and implemented by this dissector, using the definitions      */
/* below. A link to an example program showing you how to encode */
/* these headers and send LTE MAC PDUs on a UDP socket is        */
/* provided at http://wiki.wireshark.org/MAC-LTE                 */
/*                                                               */
/* A heuristic dissecter (enabled by a preference) will          */
/* recognise a signature at the beginning of these frames   .    */
/* Until someone is using this format, suggestions for changes   */
/* are welcome.                                                  */
/*****************************************************************/


/* Signature.  Rather than try to define a port for this, or make the
   port number a preference, frames will start with this string (with no
   terminating NULL */
#define MAC_LTE_START_STRING "mac-lte"

/* Fixed fields.  This is followed by the following 3 mandatory fields:
   - radioType (1 byte)
   - direction (1 byte)
   - rntiType (1 byte)
   (where the allowed values are defined above */

/* Optional fields. Attaching this info to frames will allow you
   to show you display/filter/plot/add-custom-columns on these fields, so should
   be added if available.
   The format is to have the tag, followed by the value (there is no length field,
   its implicit from the tag) */

#define MAC_LTE_RNTI_TAG            0x02
/* 2 bytes, network order */

#define MAC_LTE_UEID_TAG            0x03
/* 2 bytes, network order */

#define MAC_LTE_SUBFRAME_TAG        0x04
/* 2 bytes, network order */

#define MAC_LTE_PREDEFINED_DATA_TAG 0x05
/* 1 byte */

#define MAC_LTE_RETX_TAG            0x06
/* 1 byte */

#define MAC_LTE_CRC_STATUS_TAG      0x07
/* 1 byte */

#define MAC_LTE_EXT_BSR_SIZES_TAG   0x08
/* 0 byte */

#define MAC_LTE_OOB_EVENT_TAG   0x09
/* 3 byte */

/* MAC PDU. Following this tag comes the actual MAC PDU (there is no length, the PDU
   continues until the end of the frame) */
#define MAC_LTE_PAYLOAD_TAG 0x01


/* Set details of an LCID -> drb channel mapping.  To be called from
   configuration protocol (e.g. RRC) */
/*void set_mac_lte_channel_mapping(guint16 ueid, guint8 lcid,
                                 guint8  srbid, guint8 drbid,
                                 guint8  rlcMode, guint8 um_sn_length,
                                 guint8  ul_priority);
*/
/* Functions to be called from outside this module (e.g. in a plugin, where mac_lte_info
   isn't available) to get/set per-packet data */
//mac_lte_info *get_mac_lte_proto_data(packet_info *pinfo);
//void set_mac_lte_proto_data(packet_info *pinfo, mac_lte_info *p_mac_lte_info);

/* Function to attempt to populate p_mac_lte_info using framing definition above */
/*gboolean dissect_mac_lte_context_fields(struct mac_lte_info  *p_mac_lte_info, tvbuff_t *tvb,
                                        gint *p_offset);
*/

#endif /* PACKET_MAC_LTE_H_ */
