Subversion Repositories HelenOS

Rev

Rev 4075 | Rev 4243 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2009 Lukas Mejdrech
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup eth
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Ethernet protocol header definitions.
  35.  *  Names according to the linux src/include/linux/ip.h header file.
  36.  */
  37.  
  38. #ifndef __NET_ETH_HEADER_H__
  39. #define __NET_ETH_HEADER_H__
  40.  
  41. #include <sys/types.h>
  42.  
  43. #define ETH_ADDR        6
  44.  
  45. #define ETH_PREAMBLE    0x55
  46.  
  47. #define ETH_SFD         0xD5
  48.  
  49. /** Type definition of the Ethernet header with all the extensions.
  50.  *  @see eth_header_ex
  51.  */
  52. typedef struct eth_header_ex    eth_header_ex_t;
  53.  
  54. /** Type definition of the Ethernet header with all the extensions pointer.
  55.  *  @see eth_header
  56.  */
  57. typedef eth_header_ex_t *       eth_header_ex_ref;
  58.  
  59. /** Type definition of the Ethernet header LSAP extension.
  60.  *  @see eth_header_lsap
  61.  */
  62. typedef struct eth_header_lsap  eth_header_lsap_t;
  63.  
  64. /** Type definition of the Ethernet header LSAP extension pointer.
  65.  *  @see eth_header_lsap
  66.  */
  67. typedef eth_header_lsap_t *     eth_header_lsap_ref;
  68.  
  69. /** Type definition of the Ethernet header SNAP extension.
  70.  *  @see eth_header_snap
  71.  */
  72. typedef struct eth_header_snap  eth_header_snap_t;
  73.  
  74. /** Type definition of the Ethernet header SNAP extension pointer.
  75.  *  @see eth_header_snap
  76.  */
  77. typedef eth_header_snap_t *     eth_header_snap_ref;
  78.  
  79. /** Type definition of the Ethernet header preamble.
  80.  *  @see preamble
  81.  */
  82. typedef struct eth_preamble eth_preamble_t;
  83.  
  84. /** Type definition of the Ethernet header preamble pointer.
  85.  *  @see eth_preamble
  86.  */
  87. typedef eth_preamble_t *        eth_preamble_ref;
  88.  
  89. /** Type definition of the Ethernet header.
  90.  *  @see eth_header
  91.  */
  92. typedef struct eth_header   eth_header_t;
  93.  
  94. /** Type definition of the Ethernet header pointer.
  95.  *  @see eth_header
  96.  */
  97. typedef eth_header_t *      eth_header_ref;
  98.  
  99. /** Ethernet header Link Service Access Point extension.
  100.  */
  101. struct eth_header_lsap{
  102.     /** Destination Service Access Point identifier.
  103.      *  The possible values are assigned by an IEEE committee.
  104.      */
  105.     uint8_t     dsap;
  106.     /** Source Service Access Point identifier.
  107.      *  The possible values are assigned by an IEEE committee.
  108.      */
  109.     uint8_t     ssap;
  110.     /** Control parameter.
  111.      *  The possible values are assigned by an IEEE committee.
  112.      */
  113.     uint8_t     ctrl;
  114. };
  115.  
  116. /** Ethernet header SNAP extension.
  117.  */
  118. struct eth_header_snap{
  119.     /** Protocol identifier or organization code.
  120.      */
  121.     uint8_t     proto[ 3 ];
  122.     /** Ethernet protocol identifier in the network byte order (big endian).
  123.      *  @see ethernet_protocols.h
  124.      */
  125.     uint16_t    ethertype;
  126. };
  127.  
  128. /** Ethernet header preamble.
  129.  *  Used for dummy devices.
  130.  */
  131. struct eth_preamble{
  132.     /** Controlling preamble used for the frame transmission synchronization.
  133.      *  All should be set to ETH_PREAMBLE.
  134.      */
  135.     uint8_t     preamble[ 7 ];
  136.     /** Start of Frame Delimiter used for the frame transmission synchronization.
  137.      *  Should be set to ETH_SFD.
  138.      */
  139.     uint8_t     sfd;
  140. };
  141.  
  142. /** Ethernet header.
  143.  */
  144. struct eth_header{
  145.     /** Destination host Ethernet address (MAC address).
  146.      */
  147.     uint8_t     dest[ ETH_ADDR ];
  148.     /** Source host Ethernet address (MAC address).
  149.      */
  150.     uint8_t     src[ ETH_ADDR ];
  151.     /** Ethernet protocol identifier in the network byte order (big endian).
  152.      *  @see ethernet_protocols.h
  153.      */
  154.     uint16_t    ethertype;
  155. };
  156.  
  157. /** Ethernet header with all the extensions.
  158.  */
  159. struct eth_header_ex{
  160.     /** Ethernet header.
  161.      */
  162.     eth_header_t        header;
  163.     /** LSAP extension.
  164.      *  If DSAP and SSAP are set to ETH_LSAP_SNAP the SNAP extension is being used.
  165.      *  If DSAP and SSAP fields are equal to ETH_RAW the raw Ethernet packet without any extensions is being used and the frame content starts rigth after the two fields.
  166.      */
  167.     eth_header_lsap_t   lsap;
  168.     /** SNAP extension.
  169.      */
  170.     eth_header_snap_t   snap;
  171. };
  172.  
  173. /** Ethernet Frame Check Sequence.
  174.  */
  175. typedef uint32_t        eth_fcs_t;
  176.  
  177. /** Ethernet Frame Check Sequence pointer.
  178.  */
  179. typedef eth_fcs_t *     eth_fcs_ref;
  180.  
  181. #endif
  182.  
  183. /** @}
  184.  */
  185.