le_wifiDefs_interface.h

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