le_wifiDefs_interface.h

Go to the documentation of this file.
    1 
    2 
    3 /*
    4  * ====================== WARNING ======================
    5  *
    6  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
    7  * DO NOT MODIFY IN ANY WAY.
    8  *
    9  * ====================== WARNING ======================
   10  */
   11 
   12 /**
   13  * @file le_wifiDefs_interface.h
   14  *
   15  * Definition file common to multiple wifi related services.
   16  *
   17  * Copyright (C) Sierra Wireless Inc.
   18  */
   19 
   20 #ifndef LE_WIFIDEFS_INTERFACE_H_INCLUDE_GUARD
   21 #define LE_WIFIDEFS_INTERFACE_H_INCLUDE_GUARD
   22 
   23 
   24 #include "legato.h"
   25 
   26 
   27 
   28 
   29 
   30 //--------------------------------------------------------------------------------------------------
   31 /**
   32  * The maximum length of the textual representation of an IP address.
   33  */
   34 //--------------------------------------------------------------------------------------------------
   35 #define LE_WIFIDEFS_MAX_IP_LENGTH 15
   36 
   37 //--------------------------------------------------------------------------------------------------
   38 /**
   39  * The first WiFi channel.
   40  * @note This is only valid for 2,4 GHz WiFi frequencies.
   41  */
   42 //--------------------------------------------------------------------------------------------------
   43 #define LE_WIFIDEFS_MIN_CHANNEL_VALUE 1
   44 
   45 //--------------------------------------------------------------------------------------------------
   46 /**
   47  * The last WiFi channel.
   48  * @note This is only valid for 2,4 GHz WiFi frequencies.
   49  */
   50 //--------------------------------------------------------------------------------------------------
   51 #define LE_WIFIDEFS_MAX_CHANNEL_VALUE 14
   52 
   53 //--------------------------------------------------------------------------------------------------
   54 /**
   55  * The maximum length of the wep key.
   56  */
   57 //--------------------------------------------------------------------------------------------------
   58 #define LE_WIFIDEFS_MAX_WEPKEY_LENGTH 63
   59 
   60 //--------------------------------------------------------------------------------------------------
   61 /**
   62  * The maximum number of bytes of the wep key
   63  * One extra byte is added for the null character.
   64  */
   65 //--------------------------------------------------------------------------------------------------
   66 #define LE_WIFIDEFS_MAX_WEPKEY_BYTES 64
   67 
   68 //--------------------------------------------------------------------------------------------------
   69 /**
   70  * The minimum length of the pass-phrase used to generate PSK is 8 bytes. See 802.11-2007: H4.2.
   71  */
   72 //--------------------------------------------------------------------------------------------------
   73 #define LE_WIFIDEFS_MIN_PASSPHRASE_LENGTH 8
   74 
   75 //--------------------------------------------------------------------------------------------------
   76 /**
   77  * The maximum length of the pass-phrase used to generate PSK is 63 bytes. See 802.11-2007: H4.2.
   78  */
   79 //--------------------------------------------------------------------------------------------------
   80 #define LE_WIFIDEFS_MAX_PASSPHRASE_LENGTH 63
   81 
   82 //--------------------------------------------------------------------------------------------------
   83 /**
   84  * Maximum length of PSK, Pre Shared Key.
   85  * One extra byte is added for the null character.
   86  */
   87 //--------------------------------------------------------------------------------------------------
   88 #define LE_WIFIDEFS_MAX_PASSPHRASE_BYTES 64
   89 
   90 //--------------------------------------------------------------------------------------------------
   91 /**
   92  * The length of the PSK, Pre Shared Key, is 64 bytes. See 802.11-2007: H4.2.
   93  */
   94 //--------------------------------------------------------------------------------------------------
   95 #define LE_WIFIDEFS_MAX_PSK_LENGTH 64
   96 
   97 //--------------------------------------------------------------------------------------------------
   98 /**
   99  * Maximum length of PSK, Pre Shared Key.
  100  * One extra byte is added for the null character.
  101  */
  102 //--------------------------------------------------------------------------------------------------
  103 #define LE_WIFIDEFS_MAX_PSK_BYTES 65
  104 
  105 //--------------------------------------------------------------------------------------------------
  106 /**
  107  * Maximum length of the User-Name. RFC2865 recommends the ability to handle at least 63 octets.
  108  */
  109 //--------------------------------------------------------------------------------------------------
  110 #define LE_WIFIDEFS_MAX_USERNAME_LENGTH 63
  111 
  112 //--------------------------------------------------------------------------------------------------
  113 /**
  114  * Maximum length of the User-Name.
  115  * One extra byte is added for the null character.
  116  */
  117 //--------------------------------------------------------------------------------------------------
  118 #define LE_WIFIDEFS_MAX_USERNAME_BYTES 64
  119 
  120 //--------------------------------------------------------------------------------------------------
  121 /**
  122  * Maximum length of the User-Name. RFC2865 recommends at least 130.
  123  */
  124 //--------------------------------------------------------------------------------------------------
  125 #define LE_WIFIDEFS_MAX_PASSWORD_LENGTH 130
  126 
  127 //--------------------------------------------------------------------------------------------------
  128 /**
  129  * Maximum length of the User-Name.
  130  * One extra byte is added for the null character.
  131  */
  132 //--------------------------------------------------------------------------------------------------
  133 #define LE_WIFIDEFS_MAX_PASSWORD_BYTES 131
  134 
  135 //--------------------------------------------------------------------------------------------------
  136 /**
  137  * The minimum length of octets of the Service set identification (SSID).
  138  * @note While the values are probably human readable, this is not a string.
  139  */
  140 //--------------------------------------------------------------------------------------------------
  141 #define LE_WIFIDEFS_MIN_SSID_LENGTH 1
  142 
  143 //--------------------------------------------------------------------------------------------------
  144 /**
  145  * The maximum length of octets of the Service set identification (SSID).
  146  * @note While the values are probably human readable, this is not a string.
  147  */
  148 //--------------------------------------------------------------------------------------------------
  149 #define LE_WIFIDEFS_MAX_SSID_LENGTH 32
  150 
  151 //--------------------------------------------------------------------------------------------------
  152 /**
  153  * The maximum length of octets of the Service set identification (SSID).
  154  * @note While the values are probably human readable, this is not a string.
  155  */
  156 //--------------------------------------------------------------------------------------------------
  157 #define LE_WIFIDEFS_MAX_SSID_BYTES 33
  158 
  159 #endif // LE_WIFIDEFS_INTERFACE_H_INCLUDE_GUARD