David Fletcher
TI's CC3100 websocket camera demo with Arducam mini ov5642 and freertos. Should work with other M3's. Work in progress test demo.
simplelink/cc3100_netapp.h@1:e448e81c416f, 2015-09-11 (annotated)
- Committer:
- dflet
- Date:
- Fri Sep 11 15:38:33 2015 +0000
- Revision:
- 1:e448e81c416f
- Parent:
- 0:400d8e75a8d0
Removed some debud.
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| dflet | 0:400d8e75a8d0 | 1 | /* |
| dflet | 0:400d8e75a8d0 | 2 | * netapp.h - CC31xx/CC32xx Host Driver Implementation |
| dflet | 0:400d8e75a8d0 | 3 | * |
| dflet | 0:400d8e75a8d0 | 4 | * Copyright (C) 2014 Texas Instruments Incorporated - http://www.ti.com/ |
| dflet | 0:400d8e75a8d0 | 5 | * |
| dflet | 0:400d8e75a8d0 | 6 | * |
| dflet | 0:400d8e75a8d0 | 7 | * Redistribution and use in source and binary forms, with or without |
| dflet | 0:400d8e75a8d0 | 8 | * modification, are permitted provided that the following conditions |
| dflet | 0:400d8e75a8d0 | 9 | * are met: |
| dflet | 0:400d8e75a8d0 | 10 | * |
| dflet | 0:400d8e75a8d0 | 11 | * Redistributions of source code must retain the above copyright |
| dflet | 0:400d8e75a8d0 | 12 | * notice, this list of conditions and the following disclaimer. |
| dflet | 0:400d8e75a8d0 | 13 | * |
| dflet | 0:400d8e75a8d0 | 14 | * Redistributions in binary form must reproduce the above copyright |
| dflet | 0:400d8e75a8d0 | 15 | * notice, this list of conditions and the following disclaimer in the |
| dflet | 0:400d8e75a8d0 | 16 | * documentation and/or other materials provided with the |
| dflet | 0:400d8e75a8d0 | 17 | * distribution. |
| dflet | 0:400d8e75a8d0 | 18 | * |
| dflet | 0:400d8e75a8d0 | 19 | * Neither the name of Texas Instruments Incorporated nor the names of |
| dflet | 0:400d8e75a8d0 | 20 | * its contributors may be used to endorse or promote products derived |
| dflet | 0:400d8e75a8d0 | 21 | * from this software without specific prior written permission. |
| dflet | 0:400d8e75a8d0 | 22 | * |
| dflet | 0:400d8e75a8d0 | 23 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| dflet | 0:400d8e75a8d0 | 24 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| dflet | 0:400d8e75a8d0 | 25 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| dflet | 0:400d8e75a8d0 | 26 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| dflet | 0:400d8e75a8d0 | 27 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| dflet | 0:400d8e75a8d0 | 28 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| dflet | 0:400d8e75a8d0 | 29 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| dflet | 0:400d8e75a8d0 | 30 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| dflet | 0:400d8e75a8d0 | 31 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| dflet | 0:400d8e75a8d0 | 32 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| dflet | 0:400d8e75a8d0 | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| dflet | 0:400d8e75a8d0 | 34 | * |
| dflet | 0:400d8e75a8d0 | 35 | */ |
| dflet | 0:400d8e75a8d0 | 36 | |
| dflet | 0:400d8e75a8d0 | 37 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 38 | /* Include files */ |
| dflet | 0:400d8e75a8d0 | 39 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 40 | |
| dflet | 0:400d8e75a8d0 | 41 | #include "cc3100_simplelink.h" |
| dflet | 0:400d8e75a8d0 | 42 | |
| dflet | 0:400d8e75a8d0 | 43 | #ifndef NETAPP_H_ |
| dflet | 0:400d8e75a8d0 | 44 | #define NETAPP_H_ |
| dflet | 0:400d8e75a8d0 | 45 | |
| dflet | 0:400d8e75a8d0 | 46 | #include "cc3100_protocol.h" |
| dflet | 0:400d8e75a8d0 | 47 | #include "cc3100_nonos.h" |
| dflet | 0:400d8e75a8d0 | 48 | |
| dflet | 0:400d8e75a8d0 | 49 | namespace mbed_cc3100 { |
| dflet | 0:400d8e75a8d0 | 50 | |
| dflet | 0:400d8e75a8d0 | 51 | /*! |
| dflet | 0:400d8e75a8d0 | 52 | |
| dflet | 0:400d8e75a8d0 | 53 | \addtogroup netapp |
| dflet | 0:400d8e75a8d0 | 54 | @{ |
| dflet | 0:400d8e75a8d0 | 55 | |
| dflet | 0:400d8e75a8d0 | 56 | */ |
| dflet | 0:400d8e75a8d0 | 57 | |
| dflet | 0:400d8e75a8d0 | 58 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 59 | /* Macro declarations */ |
| dflet | 0:400d8e75a8d0 | 60 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 61 | |
| dflet | 0:400d8e75a8d0 | 62 | /*ERROR code*/ |
| dflet | 0:400d8e75a8d0 | 63 | const int16_t SL_ERROR_NETAPP_RX_BUFFER_LENGTH_ERROR = (-230); |
| dflet | 0:400d8e75a8d0 | 64 | |
| dflet | 0:400d8e75a8d0 | 65 | /* Http Server interface */ |
| dflet | 0:400d8e75a8d0 | 66 | const uint8_t MAX_INPUT_STRING = (64); /* because of WPA */ |
| dflet | 0:400d8e75a8d0 | 67 | |
| dflet | 0:400d8e75a8d0 | 68 | const uint8_t MAX_AUTH_NAME_LEN = (20); |
| dflet | 0:400d8e75a8d0 | 69 | const uint8_t MAX_AUTH_PASSWORD_LEN = (20); |
| dflet | 0:400d8e75a8d0 | 70 | const uint8_t MAX_AUTH_REALM_LEN = (20); |
| dflet | 0:400d8e75a8d0 | 71 | |
| dflet | 0:400d8e75a8d0 | 72 | const uint8_t MAX_DEVICE_URN_LEN = (15+1); |
| dflet | 0:400d8e75a8d0 | 73 | const uint8_t MAX_DOMAIN_NAME_LEN = (24+1); |
| dflet | 0:400d8e75a8d0 | 74 | |
| dflet | 0:400d8e75a8d0 | 75 | const uint8_t MAX_ACTION_LEN = (30); |
| dflet | 0:400d8e75a8d0 | 76 | /* Important: in case the max len is changed, make sure the struct sl_NetAppHttpServerSendToken_t in protocol.h is padded correctly! */ |
| dflet | 0:400d8e75a8d0 | 77 | const uint8_t MAX_TOKEN_NAME_LEN = (20); |
| dflet | 0:400d8e75a8d0 | 78 | const uint8_t MAX_TOKEN_VALUE_LEN = MAX_INPUT_STRING; |
| dflet | 0:400d8e75a8d0 | 79 | |
| dflet | 0:400d8e75a8d0 | 80 | const int16_t NETAPP_MAX_SERVICE_TEXT_SIZE = (256); |
| dflet | 0:400d8e75a8d0 | 81 | const uint8_t NETAPP_MAX_SERVICE_NAME_SIZE = (60); |
| dflet | 0:400d8e75a8d0 | 82 | const uint8_t NETAPP_MAX_SERVICE_HOST_NAME_SIZE = (64); |
| dflet | 0:400d8e75a8d0 | 83 | |
| dflet | 0:400d8e75a8d0 | 84 | |
| dflet | 0:400d8e75a8d0 | 85 | /* Server Responses */ |
| dflet | 0:400d8e75a8d0 | 86 | const uint8_t SL_NETAPP_RESPONSE_NONE = (0); |
| dflet | 0:400d8e75a8d0 | 87 | const uint8_t SL_NETAPP_HTTPSETTOKENVALUE = (1); |
| dflet | 0:400d8e75a8d0 | 88 | |
| dflet | 0:400d8e75a8d0 | 89 | const uint8_t SL_NETAPP_FAMILY_MASK = (0x80); |
| dflet | 0:400d8e75a8d0 | 90 | |
| dflet | 0:400d8e75a8d0 | 91 | /* mDNS types */ |
| dflet | 0:400d8e75a8d0 | 92 | const uint32_t SL_NET_APP_MASK_IPP_TYPE_OF_SERVICE = (0x00000001); |
| dflet | 0:400d8e75a8d0 | 93 | const uint32_t SL_NET_APP_MASK_DEVICE_INFO_TYPE_OF_SERVICE = (0x00000002); |
| dflet | 0:400d8e75a8d0 | 94 | const uint32_t SL_NET_APP_MASK_HTTP_TYPE_OF_SERVICE = (0x00000004); |
| dflet | 0:400d8e75a8d0 | 95 | const uint32_t SL_NET_APP_MASK_HTTPS_TYPE_OF_SERVICE = (0x00000008); |
| dflet | 0:400d8e75a8d0 | 96 | const uint32_t SL_NET_APP_MASK_WORKSATION_TYPE_OF_SERVICE = (0x00000010); |
| dflet | 0:400d8e75a8d0 | 97 | const uint32_t SL_NET_APP_MASK_GUID_TYPE_OF_SERVICE = (0x00000020); |
| dflet | 0:400d8e75a8d0 | 98 | const uint32_t SL_NET_APP_MASK_H323_TYPE_OF_SERVICE = (0x00000040); |
| dflet | 0:400d8e75a8d0 | 99 | const uint32_t SL_NET_APP_MASK_NTP_TYPE_OF_SERVICE = (0x00000080); |
| dflet | 0:400d8e75a8d0 | 100 | const uint32_t SL_NET_APP_MASK_OBJECITVE_TYPE_OF_SERVICE = (0x00000100); |
| dflet | 0:400d8e75a8d0 | 101 | const uint32_t SL_NET_APP_MASK_RDP_TYPE_OF_SERVICE = (0x00000200); |
| dflet | 0:400d8e75a8d0 | 102 | const uint32_t SL_NET_APP_MASK_REMOTE_TYPE_OF_SERVICE = (0x00000400); |
| dflet | 0:400d8e75a8d0 | 103 | const uint32_t SL_NET_APP_MASK_RTSP_TYPE_OF_SERVICE = (0x00000800); |
| dflet | 0:400d8e75a8d0 | 104 | const uint32_t SL_NET_APP_MASK_SIP_TYPE_OF_SERVICE = (0x00001000); |
| dflet | 0:400d8e75a8d0 | 105 | const uint32_t SL_NET_APP_MASK_SMB_TYPE_OF_SERVICE = (0x00002000); |
| dflet | 0:400d8e75a8d0 | 106 | const uint32_t SL_NET_APP_MASK_SOAP_TYPE_OF_SERVICE = (0x00004000); |
| dflet | 0:400d8e75a8d0 | 107 | const uint32_t SL_NET_APP_MASK_SSH_TYPE_OF_SERVICE = (0x00008000); |
| dflet | 0:400d8e75a8d0 | 108 | const uint32_t SL_NET_APP_MASK_TELNET_TYPE_OF_SERVICE = (0x00010000); |
| dflet | 0:400d8e75a8d0 | 109 | const uint32_t SL_NET_APP_MASK_TFTP_TYPE_OF_SERVICE = (0x00020000); |
| dflet | 0:400d8e75a8d0 | 110 | const uint32_t SL_NET_APP_MASK_XMPP_CLIENT_TYPE_OF_SERVICE = (0x00040000); |
| dflet | 0:400d8e75a8d0 | 111 | const uint32_t SL_NET_APP_MASK_RAOP_TYPE_OF_SERVICE = (0x00080000); |
| dflet | 0:400d8e75a8d0 | 112 | const uint32_t SL_NET_APP_MASK_ALL_TYPE_OF_SERVICE = (0xFFFFFFFF); |
| dflet | 0:400d8e75a8d0 | 113 | |
| dflet | 0:400d8e75a8d0 | 114 | /********************************************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 115 | /* sl_NetAppDnsGetHostByName error codes */ |
| dflet | 0:400d8e75a8d0 | 116 | |
| dflet | 0:400d8e75a8d0 | 117 | const int16_t SL_NET_APP_DNS_QUERY_NO_RESPONSE = (-159); /* DNS query failed, no response */ |
| dflet | 0:400d8e75a8d0 | 118 | const int16_t SL_NET_APP_DNS_NO_SERVER = (-161); /* No DNS server was specified */ |
| dflet | 0:400d8e75a8d0 | 119 | const int16_t SL_NET_APP_DNS_PARAM_ERROR = (-162); /* mDNS parameters error */ |
| dflet | 0:400d8e75a8d0 | 120 | const int16_t SL_NET_APP_DNS_QUERY_FAILED = (-163); /* DNS query failed; no DNS server sent an 'answer' */ |
| dflet | 0:400d8e75a8d0 | 121 | const int16_t SL_NET_APP_DNS_INTERNAL_1 = (-164); |
| dflet | 0:400d8e75a8d0 | 122 | const int16_t SL_NET_APP_DNS_INTERNAL_2 = (-165); |
| dflet | 0:400d8e75a8d0 | 123 | const int16_t SL_NET_APP_DNS_MALFORMED_PACKET = (-166); /* Improperly formed or corrupted DNS packet received */ |
| dflet | 0:400d8e75a8d0 | 124 | const int16_t SL_NET_APP_DNS_INTERNAL_3 = (-167); |
| dflet | 0:400d8e75a8d0 | 125 | const int16_t SL_NET_APP_DNS_INTERNAL_4 = (-168); |
| dflet | 0:400d8e75a8d0 | 126 | const int16_t SL_NET_APP_DNS_INTERNAL_5 = (-169); |
| dflet | 0:400d8e75a8d0 | 127 | const int16_t SL_NET_APP_DNS_INTERNAL_6 = (-170); |
| dflet | 0:400d8e75a8d0 | 128 | const int16_t SL_NET_APP_DNS_INTERNAL_7 = (-171); |
| dflet | 0:400d8e75a8d0 | 129 | const int16_t SL_NET_APP_DNS_INTERNAL_8 = (-172); |
| dflet | 0:400d8e75a8d0 | 130 | const int16_t SL_NET_APP_DNS_INTERNAL_9 = (-173); |
| dflet | 0:400d8e75a8d0 | 131 | const int16_t SL_NET_APP_DNS_MISMATCHED_RESPONSE = (-174); /* Server response type does not match the query request*/ |
| dflet | 0:400d8e75a8d0 | 132 | const int16_t SL_NET_APP_DNS_INTERNAL_10 = (-175); |
| dflet | 0:400d8e75a8d0 | 133 | const int16_t SL_NET_APP_DNS_INTERNAL_11 = (-176); |
| dflet | 0:400d8e75a8d0 | 134 | const int16_t SL_NET_APP_DNS_NO_ANSWER = (-177); /* No response for one-shot query */ |
| dflet | 0:400d8e75a8d0 | 135 | const int16_t SL_NET_APP_DNS_NO_KNOWN_ANSWER = (-178); /* No known answer for query */ |
| dflet | 0:400d8e75a8d0 | 136 | const int16_t SL_NET_APP_DNS_NAME_MISMATCH = (-179); /* Illegal service name according to the RFC */ |
| dflet | 0:400d8e75a8d0 | 137 | const int16_t SL_NET_APP_DNS_NOT_STARTED = (-180); /* mDNS is not running */ |
| dflet | 0:400d8e75a8d0 | 138 | const int16_t SL_NET_APP_DNS_HOST_NAME_ERROR = (-181); /* Host name error. Host name format is not allowed according to RFC 1033,1034,1035, 6763 */ |
| dflet | 0:400d8e75a8d0 | 139 | const int16_t SL_NET_APP_DNS_NO_MORE_ENTRIES = (-182); /* No more entries be found. */ |
| dflet | 0:400d8e75a8d0 | 140 | |
| dflet | 0:400d8e75a8d0 | 141 | const int16_t SL_NET_APP_DNS_MAX_SERVICES_ERROR = (-200); /* Maximum advertise services are already configured */ |
| dflet | 0:400d8e75a8d0 | 142 | const int16_t SL_NET_APP_DNS_IDENTICAL_SERVICES_ERROR = (-201); /* Trying to register a service that is already exists */ |
| dflet | 0:400d8e75a8d0 | 143 | const int16_t SL_NET_APP_DNS_NOT_EXISTED_SERVICE_ERROR = (-203); /* Trying to delete service that does not existed */ |
| dflet | 0:400d8e75a8d0 | 144 | const int16_t SL_NET_APP_DNS_ERROR_SERVICE_NAME_ERROR = (-204); /* Illegal service name according to the RFC */ |
| dflet | 0:400d8e75a8d0 | 145 | const int16_t SL_NET_APP_DNS_RX_PACKET_ALLOCATION_ERROR = (-205); /* Retry request */ |
| dflet | 0:400d8e75a8d0 | 146 | const int16_t SL_NET_APP_DNS_BUFFER_SIZE_ERROR = (-206); /* List size buffer is bigger than internally allowed in the NWP */ |
| dflet | 0:400d8e75a8d0 | 147 | const int16_t SL_NET_APP_DNS_NET_APP_SET_ERROR = (-207); /* Illegal length of one of the mDNS Set functions */ |
| dflet | 0:400d8e75a8d0 | 148 | const int16_t SL_NET_APP_DNS_GET_SERVICE_LIST_FLAG_ERROR = (-208); |
| dflet | 0:400d8e75a8d0 | 149 | const int16_t SL_NET_APP_DNS_NO_CONFIGURATION_ERROR = (-209); |
| dflet | 0:400d8e75a8d0 | 150 | |
| dflet | 0:400d8e75a8d0 | 151 | /* Set Dev name error codes (NETAPP_SET_GET_DEV_CONF_OPT_DEVICE_URN) */ |
| dflet | 0:400d8e75a8d0 | 152 | const int16_t SL_ERROR_DEVICE_NAME_LEN_ERR = (-117); |
| dflet | 0:400d8e75a8d0 | 153 | const int16_t SL_ERROR_DEVICE_NAME_INVALID = (-118); |
| dflet | 0:400d8e75a8d0 | 154 | /* Set domain name error codes (NETAPP_SET_GET_DEV_CONF_OPT_DOMAIN_NAME) */ |
| dflet | 0:400d8e75a8d0 | 155 | const int16_t SL_ERROR_DOMAIN_NAME_LEN_ERR = (-119); |
| dflet | 0:400d8e75a8d0 | 156 | const int16_t SL_ERROR_DOMAIN_NAME_INVALID = (-120); |
| dflet | 0:400d8e75a8d0 | 157 | |
| dflet | 0:400d8e75a8d0 | 158 | /********************************************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 159 | |
| dflet | 0:400d8e75a8d0 | 160 | /* NetApp application IDs */ |
| dflet | 0:400d8e75a8d0 | 161 | const uint8_t SL_NET_APP_HTTP_SERVER_ID = (1); |
| dflet | 0:400d8e75a8d0 | 162 | const uint8_t SL_NET_APP_DHCP_SERVER_ID = (2); |
| dflet | 0:400d8e75a8d0 | 163 | const uint8_t SL_NET_APP_MDNS_ID = (4); |
| dflet | 0:400d8e75a8d0 | 164 | const uint8_t SL_NET_APP_DNS_SERVER_ID = (8); |
| dflet | 0:400d8e75a8d0 | 165 | const uint8_t SL_NET_APP_DEVICE_CONFIG_ID = (16); |
| dflet | 0:400d8e75a8d0 | 166 | /* NetApp application set/get options */ |
| dflet | 0:400d8e75a8d0 | 167 | const uint8_t NETAPP_SET_DHCP_SRV_BASIC_OPT = (0); |
| dflet | 0:400d8e75a8d0 | 168 | /* HTTP server set/get options */ |
| dflet | 0:400d8e75a8d0 | 169 | const uint8_t NETAPP_SET_GET_HTTP_OPT_PORT_NUMBER = (0); |
| dflet | 0:400d8e75a8d0 | 170 | const uint8_t NETAPP_SET_GET_HTTP_OPT_AUTH_CHECK = (1); |
| dflet | 0:400d8e75a8d0 | 171 | const uint8_t NETAPP_SET_GET_HTTP_OPT_AUTH_NAME = (2); |
| dflet | 0:400d8e75a8d0 | 172 | const uint8_t NETAPP_SET_GET_HTTP_OPT_AUTH_PASSWORD = (3); |
| dflet | 0:400d8e75a8d0 | 173 | const uint8_t NETAPP_SET_GET_HTTP_OPT_AUTH_REALM = (4); |
| dflet | 0:400d8e75a8d0 | 174 | const uint8_t NETAPP_SET_GET_HTTP_OPT_ROM_PAGES_ACCESS = (5); |
| dflet | 0:400d8e75a8d0 | 175 | |
| dflet | 0:400d8e75a8d0 | 176 | const uint8_t NETAPP_SET_GET_MDNS_CONT_QUERY_OPT = (1); |
| dflet | 0:400d8e75a8d0 | 177 | const uint8_t NETAPP_SET_GET_MDNS_QEVETN_MASK_OPT = (2); |
| dflet | 0:400d8e75a8d0 | 178 | const uint8_t NETAPP_SET_GET_MDNS_TIMING_PARAMS_OPT = (3); |
| dflet | 0:400d8e75a8d0 | 179 | |
| dflet | 0:400d8e75a8d0 | 180 | /* DNS server set/get options */ |
| dflet | 0:400d8e75a8d0 | 181 | const uint8_t NETAPP_SET_GET_DNS_OPT_DOMAIN_NAME = (0); |
| dflet | 0:400d8e75a8d0 | 182 | |
| dflet | 0:400d8e75a8d0 | 183 | /* Device Config set/get options */ |
| dflet | 0:400d8e75a8d0 | 184 | const uint8_t NETAPP_SET_GET_DEV_CONF_OPT_DEVICE_URN = (0); |
| dflet | 0:400d8e75a8d0 | 185 | const uint8_t NETAPP_SET_GET_DEV_CONF_OPT_DOMAIN_NAME = (1); |
| dflet | 0:400d8e75a8d0 | 186 | |
| dflet | 0:400d8e75a8d0 | 187 | |
| dflet | 0:400d8e75a8d0 | 188 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 189 | /* Structure/Enum declarations */ |
| dflet | 0:400d8e75a8d0 | 190 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 191 | /* |
| dflet | 0:400d8e75a8d0 | 192 | * The below structure depict the constant parameters that are returned in the Async event answer |
| dflet | 0:400d8e75a8d0 | 193 | * according to command/API sl_DnsGetHostByService for IPv4 and IPv6. |
| dflet | 0:400d8e75a8d0 | 194 | * |
| dflet | 0:400d8e75a8d0 | 195 | 1Status - The status of the response. |
| dflet | 0:400d8e75a8d0 | 196 | 2.Address - Contains the IP address of the service. |
| dflet | 0:400d8e75a8d0 | 197 | 3.Port - Contains the port of the service. |
| dflet | 0:400d8e75a8d0 | 198 | 4.TextLen - Contains the max length of the text that the user wants to get. |
| dflet | 0:400d8e75a8d0 | 199 | it means that if the test of service is bigger that its value than |
| dflet | 0:400d8e75a8d0 | 200 | the text is cut to inout_TextLen value. |
| dflet | 0:400d8e75a8d0 | 201 | Output: Contain the length of the text that is returned. Can be full text or part |
| dflet | 0:400d8e75a8d0 | 202 | of the text (see above). |
| dflet | 0:400d8e75a8d0 | 203 | |
| dflet | 0:400d8e75a8d0 | 204 | * |
| dflet | 0:400d8e75a8d0 | 205 | */ |
| dflet | 0:400d8e75a8d0 | 206 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 207 | uint16_t Status; |
| dflet | 0:400d8e75a8d0 | 208 | uint16_t TextLen; |
| dflet | 0:400d8e75a8d0 | 209 | uint32_t Port; |
| dflet | 0:400d8e75a8d0 | 210 | uint32_t Address; |
| dflet | 0:400d8e75a8d0 | 211 | } _GetHostByServiceIPv4AsyncResponse_t; |
| dflet | 0:400d8e75a8d0 | 212 | |
| dflet | 0:400d8e75a8d0 | 213 | /* |
| dflet | 0:400d8e75a8d0 | 214 | * The below struct contains pointers to the output parameters that the user gives |
| dflet | 0:400d8e75a8d0 | 215 | * |
| dflet | 0:400d8e75a8d0 | 216 | */ |
| dflet | 0:400d8e75a8d0 | 217 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 218 | int16_t Status; |
| dflet | 0:400d8e75a8d0 | 219 | uint32_t *out_pAddr; |
| dflet | 0:400d8e75a8d0 | 220 | uint32_t *out_pPort; |
| dflet | 0:400d8e75a8d0 | 221 | uint16_t *inout_TextLen; // in: max len , out: actual len |
| dflet | 0:400d8e75a8d0 | 222 | unsigned char *out_pText; |
| dflet | 0:400d8e75a8d0 | 223 | } _GetHostByServiceAsyncResponse_t; |
| dflet | 0:400d8e75a8d0 | 224 | |
| dflet | 0:400d8e75a8d0 | 225 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 226 | uint32_t PacketsSent; |
| dflet | 0:400d8e75a8d0 | 227 | uint32_t PacketsReceived; |
| dflet | 0:400d8e75a8d0 | 228 | uint16_t MinRoundTime; |
| dflet | 0:400d8e75a8d0 | 229 | uint16_t MaxRoundTime; |
| dflet | 0:400d8e75a8d0 | 230 | uint16_t AvgRoundTime; |
| dflet | 0:400d8e75a8d0 | 231 | uint32_t TestTime; |
| dflet | 0:400d8e75a8d0 | 232 | } SlPingReport_t; |
| dflet | 0:400d8e75a8d0 | 233 | |
| dflet | 0:400d8e75a8d0 | 234 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 235 | uint32_t PingIntervalTime; /* delay between pings, in milliseconds */ |
| dflet | 0:400d8e75a8d0 | 236 | uint16_t PingSize; /* ping packet size in bytes */ |
| dflet | 0:400d8e75a8d0 | 237 | uint16_t PingRequestTimeout; /* timeout time for every ping in milliseconds */ |
| dflet | 0:400d8e75a8d0 | 238 | uint32_t TotalNumberOfAttempts; /* max number of ping requests. 0 - forever */ |
| dflet | 0:400d8e75a8d0 | 239 | uint32_t Flags; /* flag - 0 report only when finished, 1 - return response for every ping, 2 - stop after 1 successful ping. */ |
| dflet | 0:400d8e75a8d0 | 240 | uint32_t Ip; /* IPv4 address or IPv6 first 4 bytes */ |
| dflet | 0:400d8e75a8d0 | 241 | uint32_t Ip1OrPaadding; |
| dflet | 0:400d8e75a8d0 | 242 | uint32_t Ip2OrPaadding; |
| dflet | 0:400d8e75a8d0 | 243 | uint32_t Ip3OrPaadding; |
| dflet | 0:400d8e75a8d0 | 244 | } SlPingStartCommand_t; |
| dflet | 0:400d8e75a8d0 | 245 | |
| dflet | 0:400d8e75a8d0 | 246 | typedef struct _slHttpServerString_t { |
| dflet | 0:400d8e75a8d0 | 247 | uint8_t len; |
| dflet | 0:400d8e75a8d0 | 248 | uint8_t *data; |
| dflet | 0:400d8e75a8d0 | 249 | } slHttpServerString_t; |
| dflet | 0:400d8e75a8d0 | 250 | |
| dflet | 0:400d8e75a8d0 | 251 | typedef struct _slHttpServerData_t { |
| dflet | 0:400d8e75a8d0 | 252 | uint8_t value_len; |
| dflet | 0:400d8e75a8d0 | 253 | uint8_t name_len; |
| dflet | 0:400d8e75a8d0 | 254 | uint8_t *token_value; |
| dflet | 0:400d8e75a8d0 | 255 | uint8_t *token_name; |
| dflet | 0:400d8e75a8d0 | 256 | } slHttpServerData_t; |
| dflet | 0:400d8e75a8d0 | 257 | |
| dflet | 0:400d8e75a8d0 | 258 | typedef struct _slHttpServerPostData_t { |
| dflet | 0:400d8e75a8d0 | 259 | slHttpServerString_t action; |
| dflet | 0:400d8e75a8d0 | 260 | slHttpServerString_t token_name; |
| dflet | 0:400d8e75a8d0 | 261 | slHttpServerString_t token_value; |
| dflet | 0:400d8e75a8d0 | 262 | } slHttpServerPostData_t; |
| dflet | 0:400d8e75a8d0 | 263 | |
| dflet | 0:400d8e75a8d0 | 264 | typedef union { |
| dflet | 0:400d8e75a8d0 | 265 | slHttpServerString_t httpTokenName; /* SL_NETAPP_HTTPGETTOKENVALUE */ |
| dflet | 0:400d8e75a8d0 | 266 | slHttpServerPostData_t httpPostData; /* SL_NETAPP_HTTPPOSTTOKENVALUE */ |
| dflet | 0:400d8e75a8d0 | 267 | } SlHttpServerEventData_u; |
| dflet | 0:400d8e75a8d0 | 268 | |
| dflet | 0:400d8e75a8d0 | 269 | typedef union { |
| dflet | 0:400d8e75a8d0 | 270 | slHttpServerString_t token_value; |
| dflet | 0:400d8e75a8d0 | 271 | } SlHttpServerResponsedata_u; |
| dflet | 0:400d8e75a8d0 | 272 | |
| dflet | 0:400d8e75a8d0 | 273 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 274 | uint32_t Event; |
| dflet | 0:400d8e75a8d0 | 275 | SlHttpServerEventData_u EventData; |
| dflet | 0:400d8e75a8d0 | 276 | } SlHttpServerEvent_t; |
| dflet | 0:400d8e75a8d0 | 277 | |
| dflet | 0:400d8e75a8d0 | 278 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 279 | uint32_t Response; |
| dflet | 0:400d8e75a8d0 | 280 | SlHttpServerResponsedata_u ResponseData; |
| dflet | 0:400d8e75a8d0 | 281 | } SlHttpServerResponse_t; |
| dflet | 0:400d8e75a8d0 | 282 | |
| dflet | 0:400d8e75a8d0 | 283 | |
| dflet | 0:400d8e75a8d0 | 284 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 285 | uint32_t lease_time; |
| dflet | 0:400d8e75a8d0 | 286 | uint32_t ipv4_addr_start; |
| dflet | 0:400d8e75a8d0 | 287 | uint32_t ipv4_addr_last; |
| dflet | 0:400d8e75a8d0 | 288 | } SlNetAppDhcpServerBasicOpt_t; |
| dflet | 0:400d8e75a8d0 | 289 | |
| dflet | 0:400d8e75a8d0 | 290 | /*mDNS parameters*/ |
| dflet | 0:400d8e75a8d0 | 291 | typedef enum { |
| dflet | 0:400d8e75a8d0 | 292 | SL_NET_APP_FULL_SERVICE_WITH_TEXT_IPV4_TYPE = 1, |
| dflet | 0:400d8e75a8d0 | 293 | SL_NET_APP_FULL_SERVICE_IPV4_TYPE, |
| dflet | 0:400d8e75a8d0 | 294 | SL_NET_APP_SHORT_SERVICE_IPV4_TYPE |
| dflet | 0:400d8e75a8d0 | 295 | |
| dflet | 0:400d8e75a8d0 | 296 | } SlNetAppGetServiceListType_e; |
| dflet | 0:400d8e75a8d0 | 297 | |
| dflet | 0:400d8e75a8d0 | 298 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 299 | uint32_t service_ipv4; |
| dflet | 0:400d8e75a8d0 | 300 | uint16_t service_port; |
| dflet | 0:400d8e75a8d0 | 301 | uint16_t Reserved; |
| dflet | 0:400d8e75a8d0 | 302 | } SlNetAppGetShortServiceIpv4List_t; |
| dflet | 0:400d8e75a8d0 | 303 | |
| dflet | 0:400d8e75a8d0 | 304 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 305 | uint32_t service_ipv4; |
| dflet | 0:400d8e75a8d0 | 306 | uint16_t service_port; |
| dflet | 0:400d8e75a8d0 | 307 | uint16_t Reserved; |
| dflet | 0:400d8e75a8d0 | 308 | uint8_t service_name[NETAPP_MAX_SERVICE_NAME_SIZE]; |
| dflet | 0:400d8e75a8d0 | 309 | uint8_t service_host[NETAPP_MAX_SERVICE_HOST_NAME_SIZE]; |
| dflet | 0:400d8e75a8d0 | 310 | } SlNetAppGetFullServiceIpv4List_t; |
| dflet | 0:400d8e75a8d0 | 311 | |
| dflet | 0:400d8e75a8d0 | 312 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 313 | uint32_t service_ipv4; |
| dflet | 0:400d8e75a8d0 | 314 | uint16_t service_port; |
| dflet | 0:400d8e75a8d0 | 315 | uint16_t Reserved; |
| dflet | 0:400d8e75a8d0 | 316 | uint8_t service_name[NETAPP_MAX_SERVICE_NAME_SIZE]; |
| dflet | 0:400d8e75a8d0 | 317 | uint8_t service_host[NETAPP_MAX_SERVICE_HOST_NAME_SIZE]; |
| dflet | 0:400d8e75a8d0 | 318 | uint8_t service_text[NETAPP_MAX_SERVICE_TEXT_SIZE]; |
| dflet | 0:400d8e75a8d0 | 319 | } SlNetAppGetFullServiceWithTextIpv4List_t; |
| dflet | 0:400d8e75a8d0 | 320 | |
| dflet | 0:400d8e75a8d0 | 321 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 322 | /*The below parameters are used to configure the advertise times and interval |
| dflet | 0:400d8e75a8d0 | 323 | For example: |
| dflet | 0:400d8e75a8d0 | 324 | If: |
| dflet | 0:400d8e75a8d0 | 325 | Period is set to T |
| dflet | 0:400d8e75a8d0 | 326 | Repetitions are set to P |
| dflet | 0:400d8e75a8d0 | 327 | Telescopic factor is K=2 |
| dflet | 0:400d8e75a8d0 | 328 | The transmission shall be: |
| dflet | 0:400d8e75a8d0 | 329 | advertise P times |
| dflet | 0:400d8e75a8d0 | 330 | wait T |
| dflet | 0:400d8e75a8d0 | 331 | advertise P times |
| dflet | 0:400d8e75a8d0 | 332 | wait 4 * T |
| dflet | 0:400d8e75a8d0 | 333 | advertise P time |
| dflet | 0:400d8e75a8d0 | 334 | wait 16 * T ... (till max time reached / configuration changed / query issued) |
| dflet | 0:400d8e75a8d0 | 335 | */ |
| dflet | 0:400d8e75a8d0 | 336 | uint32_t t; /* Number of ticks for the initial period. Default is 100 ticks for 1 second. */ |
| dflet | 0:400d8e75a8d0 | 337 | uint32_t p; /* Number of repetitions. Default value is 1 */ |
| dflet | 0:400d8e75a8d0 | 338 | uint32_t k; /* Telescopic factor. Default value is 2. */ |
| dflet | 0:400d8e75a8d0 | 339 | uint32_t RetransInterval;/* Announcing retransmission interval */ |
| dflet | 0:400d8e75a8d0 | 340 | uint32_t Maxinterval; /* Announcing max period interval */ |
| dflet | 0:400d8e75a8d0 | 341 | uint32_t max_time; /* Announcing max time */ |
| dflet | 0:400d8e75a8d0 | 342 | } SlNetAppServiceAdvertiseTimingParameters_t; |
| dflet | 0:400d8e75a8d0 | 343 | |
| dflet | 0:400d8e75a8d0 | 344 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 345 | /* Types declarations */ |
| dflet | 0:400d8e75a8d0 | 346 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 347 | typedef void (*P_SL_DEV_PING_CALLBACK)(SlPingReport_t*); |
| dflet | 0:400d8e75a8d0 | 348 | extern P_SL_DEV_PING_CALLBACK pPingCallBackFunc; |
| dflet | 0:400d8e75a8d0 | 349 | |
| dflet | 0:400d8e75a8d0 | 350 | /***************************************************************************************** |
| dflet | 0:400d8e75a8d0 | 351 | * NETAPP structs |
| dflet | 0:400d8e75a8d0 | 352 | ******************************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 353 | |
| dflet | 0:400d8e75a8d0 | 354 | |
| dflet | 0:400d8e75a8d0 | 355 | typedef _BasicResponse_t _NetAppStartStopResponse_t; |
| dflet | 0:400d8e75a8d0 | 356 | |
| dflet | 0:400d8e75a8d0 | 357 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 358 | uint32_t appId; |
| dflet | 0:400d8e75a8d0 | 359 | } _NetAppStartStopCommand_t; |
| dflet | 0:400d8e75a8d0 | 360 | |
| dflet | 0:400d8e75a8d0 | 361 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 362 | uint16_t Status; |
| dflet | 0:400d8e75a8d0 | 363 | uint16_t AppId; |
| dflet | 0:400d8e75a8d0 | 364 | uint16_t ConfigOpt; |
| dflet | 0:400d8e75a8d0 | 365 | uint16_t ConfigLen; |
| dflet | 0:400d8e75a8d0 | 366 | } _NetAppSetGet_t; |
| dflet | 0:400d8e75a8d0 | 367 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 368 | uint16_t port_number; |
| dflet | 0:400d8e75a8d0 | 369 | } _NetAppHttpServerGetSet_port_num_t; |
| dflet | 0:400d8e75a8d0 | 370 | |
| dflet | 0:400d8e75a8d0 | 371 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 372 | uint8_t auth_enable; |
| dflet | 0:400d8e75a8d0 | 373 | } _NetAppHttpServerGetSet_auth_enable_t; |
| dflet | 0:400d8e75a8d0 | 374 | |
| dflet | 0:400d8e75a8d0 | 375 | typedef struct _sl_NetAppHttpServerGetToken_t { |
| dflet | 0:400d8e75a8d0 | 376 | uint8_t token_name_len; |
| dflet | 0:400d8e75a8d0 | 377 | uint8_t padd1; |
| dflet | 0:400d8e75a8d0 | 378 | uint16_t padd2; |
| dflet | 0:400d8e75a8d0 | 379 | } sl_NetAppHttpServerGetToken_t; |
| dflet | 0:400d8e75a8d0 | 380 | |
| dflet | 0:400d8e75a8d0 | 381 | typedef struct _sl_NetAppHttpServerSendToken_t { |
| dflet | 0:400d8e75a8d0 | 382 | uint8_t token_value_len; |
| dflet | 0:400d8e75a8d0 | 383 | uint8_t token_name_len; |
| dflet | 0:400d8e75a8d0 | 384 | uint8_t token_name[MAX_TOKEN_NAME_LEN]; |
| dflet | 0:400d8e75a8d0 | 385 | uint16_t padd; |
| dflet | 0:400d8e75a8d0 | 386 | } sl_NetAppHttpServerSendToken_t; |
| dflet | 0:400d8e75a8d0 | 387 | |
| dflet | 0:400d8e75a8d0 | 388 | typedef struct _sl_NetAppHttpServerPostToken_t { |
| dflet | 0:400d8e75a8d0 | 389 | uint8_t post_action_len; |
| dflet | 0:400d8e75a8d0 | 390 | uint8_t token_name_len; |
| dflet | 0:400d8e75a8d0 | 391 | uint8_t token_value_len; |
| dflet | 0:400d8e75a8d0 | 392 | uint8_t padding; |
| dflet | 0:400d8e75a8d0 | 393 | } sl_NetAppHttpServerPostToken_t; |
| dflet | 0:400d8e75a8d0 | 394 | |
| dflet | 0:400d8e75a8d0 | 395 | |
| dflet | 0:400d8e75a8d0 | 396 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 397 | uint16_t Len; |
| dflet | 0:400d8e75a8d0 | 398 | uint8_t family; |
| dflet | 0:400d8e75a8d0 | 399 | uint8_t padding; |
| dflet | 0:400d8e75a8d0 | 400 | } _GetHostByNameCommand_t; |
| dflet | 0:400d8e75a8d0 | 401 | |
| dflet | 0:400d8e75a8d0 | 402 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 403 | uint16_t status; |
| dflet | 0:400d8e75a8d0 | 404 | uint16_t padding; |
| dflet | 0:400d8e75a8d0 | 405 | uint32_t ip0; |
| dflet | 0:400d8e75a8d0 | 406 | uint32_t ip1; |
| dflet | 0:400d8e75a8d0 | 407 | uint32_t ip2; |
| dflet | 0:400d8e75a8d0 | 408 | uint32_t ip3; |
| dflet | 0:400d8e75a8d0 | 409 | } _GetHostByNameIPv6AsyncResponse_t; |
| dflet | 0:400d8e75a8d0 | 410 | |
| dflet | 0:400d8e75a8d0 | 411 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 412 | uint16_t status; |
| dflet | 0:400d8e75a8d0 | 413 | uint8_t padding1; |
| dflet | 0:400d8e75a8d0 | 414 | uint8_t padding2; |
| dflet | 0:400d8e75a8d0 | 415 | uint32_t ip0; |
| dflet | 0:400d8e75a8d0 | 416 | } _GetHostByNameIPv4AsyncResponse_t; |
| dflet | 0:400d8e75a8d0 | 417 | |
| dflet | 0:400d8e75a8d0 | 418 | typedef enum { |
| dflet | 0:400d8e75a8d0 | 419 | CTST_BSD_UDP_TX, |
| dflet | 0:400d8e75a8d0 | 420 | CTST_BSD_UDP_RX, |
| dflet | 0:400d8e75a8d0 | 421 | CTST_BSD_TCP_TX, |
| dflet | 0:400d8e75a8d0 | 422 | CTST_BSD_TCP_RX, |
| dflet | 0:400d8e75a8d0 | 423 | CTST_BSD_TCP_SERVER_BI_DIR, |
| dflet | 0:400d8e75a8d0 | 424 | CTST_BSD_TCP_CLIENT_BI_DIR, |
| dflet | 0:400d8e75a8d0 | 425 | CTST_BSD_UDP_BI_DIR, |
| dflet | 0:400d8e75a8d0 | 426 | CTST_BSD_RAW_TX, |
| dflet | 0:400d8e75a8d0 | 427 | CTST_BSD_RAW_RX, |
| dflet | 0:400d8e75a8d0 | 428 | CTST_BSD_RAW_BI_DIR, |
| dflet | 0:400d8e75a8d0 | 429 | CTST_BSD_SECURED_TCP_TX, |
| dflet | 0:400d8e75a8d0 | 430 | CTST_BSD_SECURED_TCP_RX, |
| dflet | 0:400d8e75a8d0 | 431 | CTST_BSD_SECURED_TCP_SERVER_BI_DIR, |
| dflet | 0:400d8e75a8d0 | 432 | CTST_BSD_SECURED_TCP_CLIENT_BI_DIR |
| dflet | 0:400d8e75a8d0 | 433 | } CommTest_e; |
| dflet | 0:400d8e75a8d0 | 434 | |
| dflet | 0:400d8e75a8d0 | 435 | typedef struct _sl_protocol_CtestStartCommand_t { |
| dflet | 0:400d8e75a8d0 | 436 | uint32_t Test; |
| dflet | 0:400d8e75a8d0 | 437 | uint16_t DestPort; |
| dflet | 0:400d8e75a8d0 | 438 | uint16_t SrcPort; |
| dflet | 0:400d8e75a8d0 | 439 | uint32_t DestAddr[4]; |
| dflet | 0:400d8e75a8d0 | 440 | uint32_t PayloadSize; |
| dflet | 0:400d8e75a8d0 | 441 | uint32_t timeout; |
| dflet | 0:400d8e75a8d0 | 442 | uint32_t csEnabled; |
| dflet | 0:400d8e75a8d0 | 443 | uint32_t secure; |
| dflet | 0:400d8e75a8d0 | 444 | uint32_t rawProtocol; |
| dflet | 0:400d8e75a8d0 | 445 | uint8_t reserved1[4]; |
| dflet | 0:400d8e75a8d0 | 446 | } _CtestStartCommand_t; |
| dflet | 0:400d8e75a8d0 | 447 | |
| dflet | 0:400d8e75a8d0 | 448 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 449 | uint8_t test; |
| dflet | 0:400d8e75a8d0 | 450 | uint8_t socket; |
| dflet | 0:400d8e75a8d0 | 451 | int16_t status; |
| dflet | 0:400d8e75a8d0 | 452 | uint32_t startTime; |
| dflet | 0:400d8e75a8d0 | 453 | uint32_t endTime; |
| dflet | 0:400d8e75a8d0 | 454 | uint16_t txKbitsSec; |
| dflet | 0:400d8e75a8d0 | 455 | uint16_t rxKbitsSec; |
| dflet | 0:400d8e75a8d0 | 456 | uint32_t outOfOrderPackets; |
| dflet | 0:400d8e75a8d0 | 457 | uint32_t missedPackets; |
| dflet | 0:400d8e75a8d0 | 458 | int16_t token; |
| dflet | 0:400d8e75a8d0 | 459 | } _CtestAsyncResponse_t; |
| dflet | 0:400d8e75a8d0 | 460 | |
| dflet | 0:400d8e75a8d0 | 461 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 462 | uint32_t pingIntervalTime; |
| dflet | 0:400d8e75a8d0 | 463 | uint16_t PingSize; |
| dflet | 0:400d8e75a8d0 | 464 | uint16_t pingRequestTimeout; |
| dflet | 0:400d8e75a8d0 | 465 | uint32_t totalNumberOfAttempts; |
| dflet | 0:400d8e75a8d0 | 466 | uint32_t flags; |
| dflet | 0:400d8e75a8d0 | 467 | uint32_t ip0; |
| dflet | 0:400d8e75a8d0 | 468 | uint32_t ip1OrPaadding; |
| dflet | 0:400d8e75a8d0 | 469 | uint32_t ip2OrPaadding; |
| dflet | 0:400d8e75a8d0 | 470 | uint32_t ip3OrPaadding; |
| dflet | 0:400d8e75a8d0 | 471 | } _PingStartCommand_t; |
| dflet | 0:400d8e75a8d0 | 472 | |
| dflet | 0:400d8e75a8d0 | 473 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 474 | uint16_t status; |
| dflet | 0:400d8e75a8d0 | 475 | uint16_t rttMin; |
| dflet | 0:400d8e75a8d0 | 476 | uint16_t rttMax; |
| dflet | 0:400d8e75a8d0 | 477 | uint16_t rttAvg; |
| dflet | 0:400d8e75a8d0 | 478 | uint32_t numSuccsessPings; |
| dflet | 0:400d8e75a8d0 | 479 | uint32_t numSendsPings; |
| dflet | 0:400d8e75a8d0 | 480 | uint32_t testTime; |
| dflet | 0:400d8e75a8d0 | 481 | } _PingReportResponse_t; |
| dflet | 0:400d8e75a8d0 | 482 | |
| dflet | 0:400d8e75a8d0 | 483 | |
| dflet | 0:400d8e75a8d0 | 484 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 485 | uint32_t ip; |
| dflet | 0:400d8e75a8d0 | 486 | uint32_t gateway; |
| dflet | 0:400d8e75a8d0 | 487 | uint32_t dns; |
| dflet | 0:400d8e75a8d0 | 488 | } _IpV4AcquiredAsync_t; |
| dflet | 0:400d8e75a8d0 | 489 | |
| dflet | 0:400d8e75a8d0 | 490 | |
| dflet | 0:400d8e75a8d0 | 491 | typedef enum { |
| dflet | 0:400d8e75a8d0 | 492 | ACQUIRED_IPV6_LOCAL = 1, |
| dflet | 0:400d8e75a8d0 | 493 | ACQUIRED_IPV6_GLOBAL |
| dflet | 0:400d8e75a8d0 | 494 | } IpV6AcquiredType_e; |
| dflet | 0:400d8e75a8d0 | 495 | |
| dflet | 0:400d8e75a8d0 | 496 | |
| dflet | 0:400d8e75a8d0 | 497 | typedef struct { |
| dflet | 0:400d8e75a8d0 | 498 | uint32_t type; |
| dflet | 0:400d8e75a8d0 | 499 | uint32_t ip[4]; |
| dflet | 0:400d8e75a8d0 | 500 | uint32_t gateway[4]; |
| dflet | 0:400d8e75a8d0 | 501 | uint32_t dns[4]; |
| dflet | 0:400d8e75a8d0 | 502 | } _IpV6AcquiredAsync_t; |
| dflet | 0:400d8e75a8d0 | 503 | |
| dflet | 0:400d8e75a8d0 | 504 | |
| dflet | 0:400d8e75a8d0 | 505 | typedef union { |
| dflet | 0:400d8e75a8d0 | 506 | _SocketCommand_t EventMask; |
| dflet | 0:400d8e75a8d0 | 507 | _sendRecvCommand_t DeviceInit; |
| dflet | 0:400d8e75a8d0 | 508 | } _device_commands_t; |
| dflet | 0:400d8e75a8d0 | 509 | |
| dflet | 0:400d8e75a8d0 | 510 | |
| dflet | 0:400d8e75a8d0 | 511 | class cc3100_netapp |
| dflet | 0:400d8e75a8d0 | 512 | { |
| dflet | 0:400d8e75a8d0 | 513 | |
| dflet | 0:400d8e75a8d0 | 514 | public: |
| dflet | 0:400d8e75a8d0 | 515 | |
| dflet | 0:400d8e75a8d0 | 516 | #ifndef SL_PLATFORM_MULTI_THREADED |
| dflet | 0:400d8e75a8d0 | 517 | cc3100_netapp(cc3100_driver &driver, cc3100_nonos &nonos); |
| dflet | 0:400d8e75a8d0 | 518 | #else |
| dflet | 0:400d8e75a8d0 | 519 | cc3100_netapp(cc3100_driver &driver); |
| dflet | 0:400d8e75a8d0 | 520 | #endif |
| dflet | 0:400d8e75a8d0 | 521 | |
| dflet | 0:400d8e75a8d0 | 522 | ~cc3100_netapp(); |
| dflet | 0:400d8e75a8d0 | 523 | |
| dflet | 0:400d8e75a8d0 | 524 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 525 | /* Functions prototypes */ |
| dflet | 0:400d8e75a8d0 | 526 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 527 | int16_t sl_NetAppMDNSRegisterUnregisterService(const char* pServiceName, |
| dflet | 0:400d8e75a8d0 | 528 | const uint8_t ServiceNameLen, |
| dflet | 0:400d8e75a8d0 | 529 | const char* pText, |
| dflet | 0:400d8e75a8d0 | 530 | const uint8_t TextLen, |
| dflet | 0:400d8e75a8d0 | 531 | const uint16_t Port, |
| dflet | 0:400d8e75a8d0 | 532 | const uint32_t TTL, |
| dflet | 0:400d8e75a8d0 | 533 | const uint32_t Options); |
| dflet | 0:400d8e75a8d0 | 534 | |
| dflet | 0:400d8e75a8d0 | 535 | void _sl_HandleAsync_DnsGetHostByAddr(void *pVoidBuf); |
| dflet | 0:400d8e75a8d0 | 536 | |
| dflet | 0:400d8e75a8d0 | 537 | void CopyPingResultsToReport(_PingReportResponse_t *pResults,SlPingReport_t *pReport); |
| dflet | 0:400d8e75a8d0 | 538 | |
| dflet | 0:400d8e75a8d0 | 539 | #if defined(sl_HttpServerCallback) || defined(EXT_LIB_REGISTERED_HTTP_SERVER_EVENTS) |
| dflet | 0:400d8e75a8d0 | 540 | uint16_t sl_NetAppSendTokenValue(slHttpServerData_t * Token); |
| dflet | 0:400d8e75a8d0 | 541 | #endif |
| dflet | 0:400d8e75a8d0 | 542 | |
| dflet | 0:400d8e75a8d0 | 543 | // uint16_t sl_NetAppSendTokenValue(slHttpServerData_t * Token); |
| dflet | 0:400d8e75a8d0 | 544 | |
| dflet | 0:400d8e75a8d0 | 545 | |
| dflet | 0:400d8e75a8d0 | 546 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 547 | /* Function prototypes */ |
| dflet | 0:400d8e75a8d0 | 548 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 549 | |
| dflet | 0:400d8e75a8d0 | 550 | |
| dflet | 0:400d8e75a8d0 | 551 | /*! |
| dflet | 0:400d8e75a8d0 | 552 | \brief Starts a network application |
| dflet | 0:400d8e75a8d0 | 553 | |
| dflet | 0:400d8e75a8d0 | 554 | Gets and starts network application for the current WLAN mode |
| dflet | 0:400d8e75a8d0 | 555 | |
| dflet | 0:400d8e75a8d0 | 556 | \param[in] AppBitMap application bitmap, could be one or combination of the following: \n |
| dflet | 0:400d8e75a8d0 | 557 | - SL_NET_APP_HTTP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 558 | - SL_NET_APP_DHCP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 559 | - SL_NET_APP_MDNS_ID |
| dflet | 0:400d8e75a8d0 | 560 | |
| dflet | 0:400d8e75a8d0 | 561 | \return On error, negative number is returned |
| dflet | 0:400d8e75a8d0 | 562 | |
| dflet | 0:400d8e75a8d0 | 563 | \sa Stop one or more the above started applications using sl_NetAppStop |
| dflet | 0:400d8e75a8d0 | 564 | \note This command activates the application for the current WLAN mode (AP or STA) |
| dflet | 0:400d8e75a8d0 | 565 | \warning |
| dflet | 0:400d8e75a8d0 | 566 | \par Example: |
| dflet | 0:400d8e75a8d0 | 567 | \code |
| dflet | 0:400d8e75a8d0 | 568 | For example: Starting internal HTTP server + DHCP server: |
| dflet | 0:400d8e75a8d0 | 569 | sl_NetAppStart(SL_NET_APP_HTTP_SERVER_ID | SL_NET_APP_DHCP_SERVER_ID) |
| dflet | 0:400d8e75a8d0 | 570 | |
| dflet | 0:400d8e75a8d0 | 571 | \endcode |
| dflet | 0:400d8e75a8d0 | 572 | */ |
| dflet | 0:400d8e75a8d0 | 573 | #if _SL_INCLUDE_FUNC(sl_NetAppStart) |
| dflet | 0:400d8e75a8d0 | 574 | int16_t sl_NetAppStart(const uint32_t AppBitMap); |
| dflet | 0:400d8e75a8d0 | 575 | #endif |
| dflet | 0:400d8e75a8d0 | 576 | /*! |
| dflet | 0:400d8e75a8d0 | 577 | \brief Stops a network application |
| dflet | 0:400d8e75a8d0 | 578 | |
| dflet | 0:400d8e75a8d0 | 579 | Gets and stops network application for the current WLAN mode |
| dflet | 0:400d8e75a8d0 | 580 | |
| dflet | 0:400d8e75a8d0 | 581 | \param[in] AppBitMap application id, could be one of the following: \n |
| dflet | 0:400d8e75a8d0 | 582 | - SL_NET_APP_HTTP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 583 | - SL_NET_APP_DHCP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 584 | - SL_NET_APP_MDNS_ID |
| dflet | 0:400d8e75a8d0 | 585 | |
| dflet | 0:400d8e75a8d0 | 586 | \return On error, negative number is returned |
| dflet | 0:400d8e75a8d0 | 587 | |
| dflet | 0:400d8e75a8d0 | 588 | \sa |
| dflet | 0:400d8e75a8d0 | 589 | \note This command disables the application for the current active WLAN mode (AP or STA) |
| dflet | 0:400d8e75a8d0 | 590 | \warning |
| dflet | 0:400d8e75a8d0 | 591 | \par Example: |
| dflet | 0:400d8e75a8d0 | 592 | \code |
| dflet | 0:400d8e75a8d0 | 593 | |
| dflet | 0:400d8e75a8d0 | 594 | For example: Stopping internal HTTP server: |
| dflet | 0:400d8e75a8d0 | 595 | sl_NetAppStop(SL_NET_APP_HTTP_SERVER_ID); |
| dflet | 0:400d8e75a8d0 | 596 | |
| dflet | 0:400d8e75a8d0 | 597 | \endcode |
| dflet | 0:400d8e75a8d0 | 598 | */ |
| dflet | 0:400d8e75a8d0 | 599 | #if _SL_INCLUDE_FUNC(sl_NetAppStop) |
| dflet | 0:400d8e75a8d0 | 600 | int16_t sl_NetAppStop(const uint32_t AppBitMap); |
| dflet | 0:400d8e75a8d0 | 601 | #endif |
| dflet | 0:400d8e75a8d0 | 602 | |
| dflet | 0:400d8e75a8d0 | 603 | /*! |
| dflet | 0:400d8e75a8d0 | 604 | \brief Get host IP by name |
| dflet | 0:400d8e75a8d0 | 605 | |
| dflet | 0:400d8e75a8d0 | 606 | Obtain the IP Address of machine on network, by machine name. |
| dflet | 0:400d8e75a8d0 | 607 | |
| dflet | 0:400d8e75a8d0 | 608 | \param[in] hostname host name |
| dflet | 0:400d8e75a8d0 | 609 | \param[in] usNameLen name length |
| dflet | 0:400d8e75a8d0 | 610 | \param[out] out_ip_addr This parameter is filled in with |
| dflet | 0:400d8e75a8d0 | 611 | host IP address. In case that host name is not |
| dflet | 0:400d8e75a8d0 | 612 | resolved, out_ip_addr is zero. |
| dflet | 0:400d8e75a8d0 | 613 | \param[in] family protocol family |
| dflet | 0:400d8e75a8d0 | 614 | |
| dflet | 0:400d8e75a8d0 | 615 | \return On success, 0 is returned. |
| dflet | 0:400d8e75a8d0 | 616 | On error, negative is returned |
| dflet | 0:400d8e75a8d0 | 617 | SL_POOL_IS_EMPTY may be return in case there are no resources in the system |
| dflet | 0:400d8e75a8d0 | 618 | In this case try again later or increase MAX_CONCURRENT_ACTIONS |
| dflet | 0:400d8e75a8d0 | 619 | Possible DNS error codes: |
| dflet | 0:400d8e75a8d0 | 620 | - SL_NET_APP_DNS_QUERY_NO_RESPONSE |
| dflet | 0:400d8e75a8d0 | 621 | - SL_NET_APP_DNS_NO_SERVER |
| dflet | 0:400d8e75a8d0 | 622 | - SL_NET_APP_DNS_QUERY_FAILED |
| dflet | 0:400d8e75a8d0 | 623 | - SL_NET_APP_DNS_MALFORMED_PACKET |
| dflet | 0:400d8e75a8d0 | 624 | - SL_NET_APP_DNS_MISMATCHED_RESPONSE |
| dflet | 0:400d8e75a8d0 | 625 | |
| dflet | 0:400d8e75a8d0 | 626 | \sa |
| dflet | 0:400d8e75a8d0 | 627 | \note Only one sl_NetAppDnsGetHostByName can be handled at a time. |
| dflet | 0:400d8e75a8d0 | 628 | Calling this API while the same command is called from another thread, may result |
| dflet | 0:400d8e75a8d0 | 629 | in one of the two scenarios: |
| dflet | 0:400d8e75a8d0 | 630 | 1. The command will wait (internal) until the previous command finish, and then be executed. |
| dflet | 0:400d8e75a8d0 | 631 | 2. There are not enough resources and POOL_IS_EMPTY error will return. |
| dflet | 0:400d8e75a8d0 | 632 | In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try |
| dflet | 0:400d8e75a8d0 | 633 | again later to issue the command. |
| dflet | 0:400d8e75a8d0 | 634 | \warning |
| dflet | 0:400d8e75a8d0 | 635 | In case an IP address in a string format is set as input, without any prefix (e.g. "1.2.3.4") the device will not |
| dflet | 0:400d8e75a8d0 | 636 | try to access the DNS and it will return the input address on the 'out_ip_addr' field |
| dflet | 0:400d8e75a8d0 | 637 | \par Example: |
| dflet | 0:400d8e75a8d0 | 638 | \code |
| dflet | 0:400d8e75a8d0 | 639 | uint32_t DestinationIP; |
| dflet | 0:400d8e75a8d0 | 640 | sl_NetAppDnsGetHostByName("www.google.com", strlen("www.google.com"), &DestinationIP,SL_AF_INET); |
| dflet | 0:400d8e75a8d0 | 641 | |
| dflet | 0:400d8e75a8d0 | 642 | Addr.sin_family = SL_AF_INET; |
| dflet | 0:400d8e75a8d0 | 643 | Addr.sin_port = sl_Htons(80); |
| dflet | 0:400d8e75a8d0 | 644 | Addr.sin_addr.s_addr = sl_Htonl(DestinationIP); |
| dflet | 0:400d8e75a8d0 | 645 | AddrSize = sizeof(SlSockAddrIn_t); |
| dflet | 0:400d8e75a8d0 | 646 | SockID = sl_Socket(SL_AF_INET,SL_SOCK_STREAM, 0); |
| dflet | 0:400d8e75a8d0 | 647 | \endcode |
| dflet | 0:400d8e75a8d0 | 648 | */ |
| dflet | 0:400d8e75a8d0 | 649 | #if _SL_INCLUDE_FUNC(sl_NetAppDnsGetHostByName) |
| dflet | 0:400d8e75a8d0 | 650 | int16_t sl_NetAppDnsGetHostByName(unsigned char * hostname, const uint16_t usNameLen, uint32_t* out_ip_addr, const uint8_t family ); |
| dflet | 0:400d8e75a8d0 | 651 | #endif |
| dflet | 0:400d8e75a8d0 | 652 | |
| dflet | 0:400d8e75a8d0 | 653 | /*! |
| dflet | 0:400d8e75a8d0 | 654 | \brief Return service attributes like IP address, port and text according to service name |
| dflet | 0:400d8e75a8d0 | 655 | \par |
| dflet | 0:400d8e75a8d0 | 656 | The user sets a service name Full/Part (see example below), and should get: |
| dflet | 0:400d8e75a8d0 | 657 | - IP of service |
| dflet | 0:400d8e75a8d0 | 658 | - The port of service |
| dflet | 0:400d8e75a8d0 | 659 | - The text of service |
| dflet | 0:400d8e75a8d0 | 660 | |
| dflet | 0:400d8e75a8d0 | 661 | Hence it can make a connection to the specific service and use it. |
| dflet | 0:400d8e75a8d0 | 662 | It is similar to get host by name method. |
| dflet | 0:400d8e75a8d0 | 663 | It is done by a single shot query with PTR type on the service name. |
| dflet | 0:400d8e75a8d0 | 664 | The command that is sent is from constant parameters and variables parameters. |
| dflet | 0:400d8e75a8d0 | 665 | |
| dflet | 0:400d8e75a8d0 | 666 | \param[in] pService Service name can be full or partial. \n |
| dflet | 0:400d8e75a8d0 | 667 | Example for full service name: |
| dflet | 0:400d8e75a8d0 | 668 | 1. PC1._ipp._tcp.local |
| dflet | 0:400d8e75a8d0 | 669 | 2. PC2_server._ftp._tcp.local \n |
| dflet | 0:400d8e75a8d0 | 670 | . |
| dflet | 0:400d8e75a8d0 | 671 | Example for partial service name: |
| dflet | 0:400d8e75a8d0 | 672 | 1. _ipp._tcp.local |
| dflet | 0:400d8e75a8d0 | 673 | 2. _ftp._tcp.local |
| dflet | 0:400d8e75a8d0 | 674 | |
| dflet | 0:400d8e75a8d0 | 675 | \param[in] ServiceLen The length of the service name (in_pService). |
| dflet | 0:400d8e75a8d0 | 676 | \param[in] Family IPv4 or IPv6 (SL_AF_INET , SL_AF_INET6). |
| dflet | 0:400d8e75a8d0 | 677 | \param[out] pAddr Contains the IP address of the service. |
| dflet | 0:400d8e75a8d0 | 678 | \param[out] pPort Contains the port of the service. |
| dflet | 0:400d8e75a8d0 | 679 | \param[out] pTextLen Has 2 options. One as Input field and the other one as output: |
| dflet | 0:400d8e75a8d0 | 680 | - Input: \n |
| dflet | 0:400d8e75a8d0 | 681 | Contains the max length of the text that the user wants to get.\n |
| dflet | 0:400d8e75a8d0 | 682 | It means that if the text len of service is bigger that its value than |
| dflet | 0:400d8e75a8d0 | 683 | the text is cut to inout_TextLen value. |
| dflet | 0:400d8e75a8d0 | 684 | - Output: \n |
| dflet | 0:400d8e75a8d0 | 685 | Contain the length of the text that is returned. Can be full text or part of the text (see above). |
| dflet | 0:400d8e75a8d0 | 686 | |
| dflet | 0:400d8e75a8d0 | 687 | \param[out] pOut_pText Contains the text of the service full or partial |
| dflet | 0:400d8e75a8d0 | 688 | |
| dflet | 0:400d8e75a8d0 | 689 | \return On success, zero is returned |
| dflet | 0:400d8e75a8d0 | 690 | SL_POOL_IS_EMPTY may be return in case there are no resources in the system |
| dflet | 0:400d8e75a8d0 | 691 | In this case try again later or increase MAX_CONCURRENT_ACTIONS |
| dflet | 0:400d8e75a8d0 | 692 | In case No service is found error SL_NET_APP_DNS_NO_ANSWER will be returned |
| dflet | 0:400d8e75a8d0 | 693 | |
| dflet | 0:400d8e75a8d0 | 694 | \note The returns attributes belongs to the first service found. |
| dflet | 0:400d8e75a8d0 | 695 | There may be other services with the same service name that will response to the query. |
| dflet | 0:400d8e75a8d0 | 696 | The results of these responses are saved in the peer cache of the Device and should be read by another API. |
| dflet | 0:400d8e75a8d0 | 697 | |
| dflet | 0:400d8e75a8d0 | 698 | Only one sl_NetAppDnsGetHostByService can be handled at a time. |
| dflet | 0:400d8e75a8d0 | 699 | Calling this API while the same command is called from another thread, may result |
| dflet | 0:400d8e75a8d0 | 700 | in one of the two scenarios: |
| dflet | 0:400d8e75a8d0 | 701 | 1. The command will wait (internal) until the previous command finish, and then be executed. |
| dflet | 0:400d8e75a8d0 | 702 | 2. There are not enough resources and SL_POOL_IS_EMPTY error will return. |
| dflet | 0:400d8e75a8d0 | 703 | In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try |
| dflet | 0:400d8e75a8d0 | 704 | again later to issue the command. |
| dflet | 0:400d8e75a8d0 | 705 | |
| dflet | 0:400d8e75a8d0 | 706 | \warning Text length can be 120 bytes only |
| dflet | 0:400d8e75a8d0 | 707 | */ |
| dflet | 0:400d8e75a8d0 | 708 | #if _SL_INCLUDE_FUNC(sl_NetAppDnsGetHostByService) |
| dflet | 0:400d8e75a8d0 | 709 | int32_t sl_NetAppDnsGetHostByService(unsigned char *pServiceName, /* string containing all (or only part): name + subtype + service */ |
| dflet | 0:400d8e75a8d0 | 710 | const uint8_t ServiceLen, |
| dflet | 0:400d8e75a8d0 | 711 | const uint8_t Family, /* 4-IPv4 , 16-IPv6 */ |
| dflet | 0:400d8e75a8d0 | 712 | uint32_t pAddr[], |
| dflet | 0:400d8e75a8d0 | 713 | uint32_t *pPort, |
| dflet | 0:400d8e75a8d0 | 714 | uint16_t *pTextLen, /* in: max len , out: actual len */ |
| dflet | 0:400d8e75a8d0 | 715 | unsigned char *pText |
| dflet | 0:400d8e75a8d0 | 716 | ); |
| dflet | 0:400d8e75a8d0 | 717 | |
| dflet | 0:400d8e75a8d0 | 718 | #endif |
| dflet | 0:400d8e75a8d0 | 719 | |
| dflet | 0:400d8e75a8d0 | 720 | /*! |
| dflet | 0:400d8e75a8d0 | 721 | \brief Get service List |
| dflet | 0:400d8e75a8d0 | 722 | Insert into out pBuffer a list of peer's services that are the NWP. |
| dflet | 0:400d8e75a8d0 | 723 | The list is in a form of service struct. The user should chose the type |
| dflet | 0:400d8e75a8d0 | 724 | of the service struct like: |
| dflet | 0:400d8e75a8d0 | 725 | - Full service parameters with text. |
| dflet | 0:400d8e75a8d0 | 726 | - Full service parameters. |
| dflet | 0:400d8e75a8d0 | 727 | - Short service parameters (port and IP only) especially for tiny hosts. |
| dflet | 0:400d8e75a8d0 | 728 | |
| dflet | 0:400d8e75a8d0 | 729 | The different types of struct are made to give the |
| dflet | 0:400d8e75a8d0 | 730 | Possibility to save memory in the host |
| dflet | 0:400d8e75a8d0 | 731 | |
| dflet | 0:400d8e75a8d0 | 732 | |
| dflet | 0:400d8e75a8d0 | 733 | The user also chose how many max services to get and start point index |
| dflet | 0:400d8e75a8d0 | 734 | NWP peer cache. |
| dflet | 0:400d8e75a8d0 | 735 | For example: |
| dflet | 0:400d8e75a8d0 | 736 | 1. Get max of 3 full services from index 0.Up to 3 full services |
| dflet | 0:400d8e75a8d0 | 737 | from index 0 are inserted into pBuffer (services that are in indexes 0,1,2). |
| dflet | 0:400d8e75a8d0 | 738 | 2. Get max of 4 full services from index 3.Up to 4 full services |
| dflet | 0:400d8e75a8d0 | 739 | from index 3 are inserted into pBuffer (services that are in indexes 3,4,5,6). |
| dflet | 0:400d8e75a8d0 | 740 | 3. Get max of 2 int services from index 6.Up to 2 int services |
| dflet | 0:400d8e75a8d0 | 741 | from index 6 are inserted into pBuffer (services that are in indexes 6,7). |
| dflet | 0:400d8e75a8d0 | 742 | |
| dflet | 0:400d8e75a8d0 | 743 | See below - command parameters. |
| dflet | 0:400d8e75a8d0 | 744 | |
| dflet | 0:400d8e75a8d0 | 745 | \param[in] indexOffset - The start index in the peer cache that from it the first service is returned. |
| dflet | 0:400d8e75a8d0 | 746 | \param[in] MaxServiceCount - The Max services that can be returned if existed or if not exceed the max index |
| dflet | 0:400d8e75a8d0 | 747 | in the peer cache |
| dflet | 0:400d8e75a8d0 | 748 | \param[in] Flags - an ENUM number that means which service struct to use (means which types of service to fill) |
| dflet | 0:400d8e75a8d0 | 749 | - use SlNetAppGetFullServiceWithTextIpv4List_t |
| dflet | 0:400d8e75a8d0 | 750 | - use SlNetAppGetFullServiceIpv4List_t |
| dflet | 0:400d8e75a8d0 | 751 | - use SlNetAppGetShortServiceIpv4List_t |
| dflet | 0:400d8e75a8d0 | 752 | |
| dflet | 0:400d8e75a8d0 | 753 | \param[out] Buffer - The Services are inserted into this buffer. In the struct form according to the bit that is set in the Flags |
| dflet | 0:400d8e75a8d0 | 754 | input parameter. |
| dflet | 0:400d8e75a8d0 | 755 | |
| dflet | 0:400d8e75a8d0 | 756 | \return ServiceFoundCount - The number of the services that were inserted into the buffer. zero means no service is found |
| dflet | 0:400d8e75a8d0 | 757 | negative number means an error |
| dflet | 0:400d8e75a8d0 | 758 | \sa sl_NetAppMDNSRegisterService |
| dflet | 0:400d8e75a8d0 | 759 | \note |
| dflet | 0:400d8e75a8d0 | 760 | \warning |
| dflet | 0:400d8e75a8d0 | 761 | if the out pBuffer size is bigger than an RX packet(1480), than |
| dflet | 0:400d8e75a8d0 | 762 | an error is returned because there |
| dflet | 0:400d8e75a8d0 | 763 | is no place in the RX packet. |
| dflet | 0:400d8e75a8d0 | 764 | The size is a multiply of MaxServiceCount and size of service struct(that is set |
| dflet | 0:400d8e75a8d0 | 765 | according to flag value). |
| dflet | 0:400d8e75a8d0 | 766 | */ |
| dflet | 0:400d8e75a8d0 | 767 | |
| dflet | 0:400d8e75a8d0 | 768 | #if _SL_INCLUDE_FUNC(sl_NetAppGetServiceList) |
| dflet | 0:400d8e75a8d0 | 769 | int16_t sl_NetAppGetServiceList(const uint8_t IndexOffest, |
| dflet | 0:400d8e75a8d0 | 770 | const uint8_t MaxServiceCount, |
| dflet | 0:400d8e75a8d0 | 771 | const uint8_t Flags, |
| dflet | 0:400d8e75a8d0 | 772 | int8_t *pBuffer, |
| dflet | 0:400d8e75a8d0 | 773 | const uint32_t RxBufferLength |
| dflet | 0:400d8e75a8d0 | 774 | ); |
| dflet | 0:400d8e75a8d0 | 775 | |
| dflet | 0:400d8e75a8d0 | 776 | #endif |
| dflet | 0:400d8e75a8d0 | 777 | |
| dflet | 0:400d8e75a8d0 | 778 | /*! |
| dflet | 0:400d8e75a8d0 | 779 | \brief Unregister mDNS service |
| dflet | 0:400d8e75a8d0 | 780 | This function deletes the mDNS service from the mDNS package and the database. |
| dflet | 0:400d8e75a8d0 | 781 | |
| dflet | 0:400d8e75a8d0 | 782 | The mDNS service that is to be unregistered is a service that the application no longer wishes to provide. \n |
| dflet | 0:400d8e75a8d0 | 783 | The service name should be the full service name according to RFC |
| dflet | 0:400d8e75a8d0 | 784 | of the DNS-SD - meaning the value in name field in the SRV answer. |
| dflet | 0:400d8e75a8d0 | 785 | |
| dflet | 0:400d8e75a8d0 | 786 | Examples for service names: |
| dflet | 0:400d8e75a8d0 | 787 | 1. PC1._ipp._tcp.local |
| dflet | 0:400d8e75a8d0 | 788 | 2. PC2_server._ftp._tcp.local |
| dflet | 0:400d8e75a8d0 | 789 | |
| dflet | 0:400d8e75a8d0 | 790 | \param[in] pServiceName Full service name. \n |
| dflet | 0:400d8e75a8d0 | 791 | Example for service name: |
| dflet | 0:400d8e75a8d0 | 792 | 1. PC1._ipp._tcp.local |
| dflet | 0:400d8e75a8d0 | 793 | 2. PC2_server._ftp._tcp.local |
| dflet | 0:400d8e75a8d0 | 794 | \param[in] ServiceLen The length of the service. |
| dflet | 0:400d8e75a8d0 | 795 | \return On success, zero is returned |
| dflet | 0:400d8e75a8d0 | 796 | \sa sl_NetAppMDNSRegisterService |
| dflet | 0:400d8e75a8d0 | 797 | \note |
| dflet | 0:400d8e75a8d0 | 798 | \warning |
| dflet | 0:400d8e75a8d0 | 799 | The size of the service length should be smaller than 255. |
| dflet | 0:400d8e75a8d0 | 800 | */ |
| dflet | 0:400d8e75a8d0 | 801 | #if _SL_INCLUDE_FUNC(sl_NetAppMDNSUnRegisterService) |
| dflet | 0:400d8e75a8d0 | 802 | int16_t sl_NetAppMDNSUnRegisterService(const char *pServiceName, const uint8_t ServiceNameLen); |
| dflet | 0:400d8e75a8d0 | 803 | #endif |
| dflet | 0:400d8e75a8d0 | 804 | |
| dflet | 0:400d8e75a8d0 | 805 | /*! |
| dflet | 0:400d8e75a8d0 | 806 | \brief Register a new mDNS service |
| dflet | 0:400d8e75a8d0 | 807 | \par |
| dflet | 0:400d8e75a8d0 | 808 | This function registers a new mDNS service to the mDNS package and the DB. |
| dflet | 0:400d8e75a8d0 | 809 | |
| dflet | 0:400d8e75a8d0 | 810 | This registered service is a service offered by the application. |
| dflet | 0:400d8e75a8d0 | 811 | The service name should be full service name according to RFC |
| dflet | 0:400d8e75a8d0 | 812 | of the DNS-SD - meaning the value in name field in the SRV answer. |
| dflet | 0:400d8e75a8d0 | 813 | Example for service name: |
| dflet | 0:400d8e75a8d0 | 814 | 1. PC1._ipp._tcp.local |
| dflet | 0:400d8e75a8d0 | 815 | 2. PC2_server._ftp._tcp.local |
| dflet | 0:400d8e75a8d0 | 816 | |
| dflet | 0:400d8e75a8d0 | 817 | If the option is_unique is set, mDNS probes the service name to make sure |
| dflet | 0:400d8e75a8d0 | 818 | it is unique before starting to announce the service on the network. |
| dflet | 0:400d8e75a8d0 | 819 | Instance is the instance portion of the service name. |
| dflet | 0:400d8e75a8d0 | 820 | |
| dflet | 0:400d8e75a8d0 | 821 | \param[in] ServiceLen The length of the service. |
| dflet | 0:400d8e75a8d0 | 822 | \param[in] TextLen The length of the service should be smaller than 64. |
| dflet | 0:400d8e75a8d0 | 823 | \param[in] port The port on this target host port. |
| dflet | 0:400d8e75a8d0 | 824 | \param[in] TTL The TTL of the service |
| dflet | 0:400d8e75a8d0 | 825 | \param[in] Options bitwise parameters: \n |
| dflet | 0:400d8e75a8d0 | 826 | - bit 0 - service is unique (means that the service needs to be unique) |
| dflet | 0:400d8e75a8d0 | 827 | - bit 31 - for internal use if the service should be added or deleted (set means ADD). |
| dflet | 0:400d8e75a8d0 | 828 | - bit 1-30 for future. |
| dflet | 0:400d8e75a8d0 | 829 | |
| dflet | 0:400d8e75a8d0 | 830 | \param[in] pServiceName The service name. |
| dflet | 0:400d8e75a8d0 | 831 | Example for service name: \n |
| dflet | 0:400d8e75a8d0 | 832 | 1. PC1._ipp._tcp.local |
| dflet | 0:400d8e75a8d0 | 833 | 2. PC2_server._ftp._tcp.local |
| dflet | 0:400d8e75a8d0 | 834 | |
| dflet | 0:400d8e75a8d0 | 835 | \param[in] pText The description of the service. |
| dflet | 0:400d8e75a8d0 | 836 | should be as mentioned in the RFC |
| dflet | 0:400d8e75a8d0 | 837 | (according to type of the service IPP,FTP...) |
| dflet | 0:400d8e75a8d0 | 838 | |
| dflet | 0:400d8e75a8d0 | 839 | \return On success, zero is returned |
| dflet | 0:400d8e75a8d0 | 840 | Possible error codes: |
| dflet | 0:400d8e75a8d0 | 841 | - Maximum advertise services are already configured. |
| dflet | 0:400d8e75a8d0 | 842 | Delete another existed service that is registered and then register again the new service |
| dflet | 0:400d8e75a8d0 | 843 | - Trying to register a service that is already exists |
| dflet | 0:400d8e75a8d0 | 844 | - Trying to delete service that does not existed |
| dflet | 0:400d8e75a8d0 | 845 | - Illegal service name according to the RFC |
| dflet | 0:400d8e75a8d0 | 846 | - Retry request |
| dflet | 0:400d8e75a8d0 | 847 | - Illegal length of one of the mDNS Set functions |
| dflet | 0:400d8e75a8d0 | 848 | - mDNS is not operational as the device has no IP.Connect the device to an AP to get an IP address. |
| dflet | 0:400d8e75a8d0 | 849 | - mDNS parameters error |
| dflet | 0:400d8e75a8d0 | 850 | - mDNS internal cache error |
| dflet | 0:400d8e75a8d0 | 851 | - mDNS internal error |
| dflet | 0:400d8e75a8d0 | 852 | - Adding a service is not allowed as it is already exist (duplicate service) |
| dflet | 0:400d8e75a8d0 | 853 | - mDNS is not running |
| dflet | 0:400d8e75a8d0 | 854 | - Host name error. Host name format is not allowed according to RFC 1033,1034,1035, 6763 |
| dflet | 0:400d8e75a8d0 | 855 | - List size buffer is bigger than internally allowed in the NWP (API get service list), |
| dflet | 0:400d8e75a8d0 | 856 | change the APIs� parameters to decrease the size of the list |
| dflet | 0:400d8e75a8d0 | 857 | |
| dflet | 0:400d8e75a8d0 | 858 | |
| dflet | 0:400d8e75a8d0 | 859 | \sa sl_NetAppMDNSUnRegisterService |
| dflet | 0:400d8e75a8d0 | 860 | |
| dflet | 0:400d8e75a8d0 | 861 | \warning 1) Temporary - there is an allocation on stack of internal buffer. |
| dflet | 0:400d8e75a8d0 | 862 | Its size is NETAPP_MDNS_MAX_SERVICE_NAME_AND_TEXT_LENGTH. \n |
| dflet | 0:400d8e75a8d0 | 863 | It means that the sum of the text length and service name length cannot be bigger than |
| dflet | 0:400d8e75a8d0 | 864 | NETAPP_MDNS_MAX_SERVICE_NAME_AND_TEXT_LENGTH.\n |
| dflet | 0:400d8e75a8d0 | 865 | If it is - An error is returned. \n |
| dflet | 0:400d8e75a8d0 | 866 | 2) According to now from certain constraints the variables parameters are set in the |
| dflet | 0:400d8e75a8d0 | 867 | attribute part (contain constant parameters) |
| dflet | 0:400d8e75a8d0 | 868 | */ |
| dflet | 0:400d8e75a8d0 | 869 | #if _SL_INCLUDE_FUNC(sl_NetAppMDNSRegisterService) |
| dflet | 0:400d8e75a8d0 | 870 | int16_t sl_NetAppMDNSRegisterService( const char* pServiceName, |
| dflet | 0:400d8e75a8d0 | 871 | const uint8_t ServiceNameLen, |
| dflet | 0:400d8e75a8d0 | 872 | const char* pText, |
| dflet | 0:400d8e75a8d0 | 873 | const uint8_t TextLen, |
| dflet | 0:400d8e75a8d0 | 874 | const uint16_t Port, |
| dflet | 0:400d8e75a8d0 | 875 | const uint32_t TTL, |
| dflet | 0:400d8e75a8d0 | 876 | uint32_t Options); |
| dflet | 0:400d8e75a8d0 | 877 | #endif |
| dflet | 0:400d8e75a8d0 | 878 | |
| dflet | 0:400d8e75a8d0 | 879 | /*! |
| dflet | 0:400d8e75a8d0 | 880 | \brief send ICMP ECHO_REQUEST to network hosts |
| dflet | 0:400d8e75a8d0 | 881 | |
| dflet | 0:400d8e75a8d0 | 882 | Ping uses the ICMP protocol's mandatory ECHO_REQUEST |
| dflet | 0:400d8e75a8d0 | 883 | |
| dflet | 0:400d8e75a8d0 | 884 | \param[in] pPingParams Pointer to the ping request structure: \n |
| dflet | 0:400d8e75a8d0 | 885 | - if flags parameter is set to 0, ping will report back once all requested pings are done (as defined by TotalNumberOfAttempts). \n |
| dflet | 0:400d8e75a8d0 | 886 | - if flags parameter is set to 1, ping will report back after every ping, for TotalNumberOfAttempts. |
| dflet | 0:400d8e75a8d0 | 887 | - if flags parameter is set to 2, ping will stop after the first successful ping, and report back for the successful ping, as well as any preceding failed ones. |
| dflet | 0:400d8e75a8d0 | 888 | For stopping an ongoing ping activity, set parameters IP address to 0 |
| dflet | 0:400d8e75a8d0 | 889 | |
| dflet | 0:400d8e75a8d0 | 890 | \param[in] family SL_AF_INET or SL_AF_INET6 |
| dflet | 0:400d8e75a8d0 | 891 | \param[out] pReport Ping pReport |
| dflet | 0:400d8e75a8d0 | 892 | \param[out] pCallback Callback function upon completion. |
| dflet | 0:400d8e75a8d0 | 893 | If callback is NULL, the API is blocked until data arrives |
| dflet | 0:400d8e75a8d0 | 894 | |
| dflet | 0:400d8e75a8d0 | 895 | |
| dflet | 0:400d8e75a8d0 | 896 | \return On success, zero is returned. On error, -1 is returned |
| dflet | 0:400d8e75a8d0 | 897 | SL_POOL_IS_EMPTY may be return in case there are no resources in the system |
| dflet | 0:400d8e75a8d0 | 898 | In this case try again later or increase MAX_CONCURRENT_ACTIONS |
| dflet | 0:400d8e75a8d0 | 899 | |
| dflet | 0:400d8e75a8d0 | 900 | \sa sl_NetAppPingReport |
| dflet | 0:400d8e75a8d0 | 901 | \note Only one sl_NetAppPingStart can be handled at a time. |
| dflet | 0:400d8e75a8d0 | 902 | Calling this API while the same command is called from another thread, may result |
| dflet | 0:400d8e75a8d0 | 903 | in one of the two scenarios: |
| dflet | 0:400d8e75a8d0 | 904 | 1. The command will wait (internal) until the previous command finish, and then be executed. |
| dflet | 0:400d8e75a8d0 | 905 | 2. There are not enough resources and SL_POOL_IS_EMPTY error will return. |
| dflet | 0:400d8e75a8d0 | 906 | In this case, MAX_CONCURRENT_ACTIONS can be increased (result in memory increase) or try |
| dflet | 0:400d8e75a8d0 | 907 | again later to issue the command. |
| dflet | 0:400d8e75a8d0 | 908 | \warning |
| dflet | 0:400d8e75a8d0 | 909 | \par Example: |
| dflet | 0:400d8e75a8d0 | 910 | \code |
| dflet | 0:400d8e75a8d0 | 911 | |
| dflet | 0:400d8e75a8d0 | 912 | An example of sending 20 ping requests and reporting results to a callback routine when |
| dflet | 0:400d8e75a8d0 | 913 | all requests are sent: |
| dflet | 0:400d8e75a8d0 | 914 | |
| dflet | 0:400d8e75a8d0 | 915 | // callback routine |
| dflet | 0:400d8e75a8d0 | 916 | void pingRes(SlPingReport_t* pReport) |
| dflet | 0:400d8e75a8d0 | 917 | { |
| dflet | 0:400d8e75a8d0 | 918 | // handle ping results |
| dflet | 0:400d8e75a8d0 | 919 | } |
| dflet | 0:400d8e75a8d0 | 920 | |
| dflet | 0:400d8e75a8d0 | 921 | // ping activation |
| dflet | 0:400d8e75a8d0 | 922 | void PingTest() |
| dflet | 0:400d8e75a8d0 | 923 | { |
| dflet | 0:400d8e75a8d0 | 924 | SlPingReport_t report; |
| dflet | 0:400d8e75a8d0 | 925 | SlPingStartCommand_t pingCommand; |
| dflet | 0:400d8e75a8d0 | 926 | |
| dflet | 0:400d8e75a8d0 | 927 | pingCommand.Ip = SL_IPV4_VAL(10,1,1,200); // destination IP address is 10.1.1.200 |
| dflet | 0:400d8e75a8d0 | 928 | pingCommand.PingSize = 150; // size of ping, in bytes |
| dflet | 0:400d8e75a8d0 | 929 | pingCommand.PingIntervalTime = 100; // delay between pings, in milliseconds |
| dflet | 0:400d8e75a8d0 | 930 | pingCommand.PingRequestTimeout = 1000; // timeout for every ping in milliseconds |
| dflet | 0:400d8e75a8d0 | 931 | pingCommand.TotalNumberOfAttempts = 20; // max number of ping requests. 0 - forever |
| dflet | 0:400d8e75a8d0 | 932 | pingCommand.Flags = 0; // report only when finished |
| dflet | 0:400d8e75a8d0 | 933 | |
| dflet | 0:400d8e75a8d0 | 934 | sl_NetAppPingStart( &pingCommand, SL_AF_INET, &report, pingRes ) ; |
| dflet | 0:400d8e75a8d0 | 935 | } |
| dflet | 0:400d8e75a8d0 | 936 | |
| dflet | 0:400d8e75a8d0 | 937 | \endcode |
| dflet | 0:400d8e75a8d0 | 938 | */ |
| dflet | 0:400d8e75a8d0 | 939 | #if _SL_INCLUDE_FUNC(sl_NetAppPingStart) |
| dflet | 0:400d8e75a8d0 | 940 | int16_t sl_NetAppPingStart(const SlPingStartCommand_t* pPingParams, const uint8_t family,SlPingReport_t *pReport, const P_SL_DEV_PING_CALLBACK pPingCallback); |
| dflet | 0:400d8e75a8d0 | 941 | #endif |
| dflet | 0:400d8e75a8d0 | 942 | |
| dflet | 0:400d8e75a8d0 | 943 | /*! |
| dflet | 0:400d8e75a8d0 | 944 | \brief Internal function for setting network application configurations |
| dflet | 0:400d8e75a8d0 | 945 | |
| dflet | 0:400d8e75a8d0 | 946 | \return On success, zero is returned. On error, -1 is |
| dflet | 0:400d8e75a8d0 | 947 | returned |
| dflet | 0:400d8e75a8d0 | 948 | |
| dflet | 0:400d8e75a8d0 | 949 | \param[in] AppId Application id, could be one of the following: \n |
| dflet | 0:400d8e75a8d0 | 950 | - SL_NET_APP_HTTP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 951 | - SL_NET_APP_DHCP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 952 | - SL_NET_APP_MDNS_ID |
| dflet | 0:400d8e75a8d0 | 953 | - SL_NET_APP_DEVICE_CONFIG_ID |
| dflet | 0:400d8e75a8d0 | 954 | |
| dflet | 0:400d8e75a8d0 | 955 | \param[in] SetOptions set option, could be one of the following: \n |
| dflet | 0:400d8e75a8d0 | 956 | - SL_NET_APP_DHCP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 957 | - NETAPP_SET_DHCP_SRV_BASIC_OPT |
| dflet | 0:400d8e75a8d0 | 958 | - SL_NET_APP_HTTP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 959 | - NETAPP_SET_GET_HTTP_OPT_PORT_NUMBER |
| dflet | 0:400d8e75a8d0 | 960 | - NETAPP_SET_GET_HTTP_OPT_AUTH_CHECK |
| dflet | 0:400d8e75a8d0 | 961 | - NETAPP_SET_GET_HTTP_OPT_AUTH_NAME |
| dflet | 0:400d8e75a8d0 | 962 | - NETAPP_SET_GET_HTTP_OPT_AUTH_PASSWORD |
| dflet | 0:400d8e75a8d0 | 963 | - NETAPP_SET_GET_HTTP_OPT_AUTH_REALM |
| dflet | 0:400d8e75a8d0 | 964 | - NETAPP_SET_GET_HTTP_OPT_ROM_PAGES_ACCESS |
| dflet | 0:400d8e75a8d0 | 965 | - SL_NET_APP_MDNS_ID |
| dflet | 0:400d8e75a8d0 | 966 | - NETAPP_SET_GET_MDNS_CONT_QUERY_OPT |
| dflet | 0:400d8e75a8d0 | 967 | - NETAPP_SET_GET_MDNS_QEVETN_MASK_OPT |
| dflet | 0:400d8e75a8d0 | 968 | - NETAPP_SET_GET_MDNS_TIMING_PARAMS_OPT |
| dflet | 0:400d8e75a8d0 | 969 | - SL_NET_APP_DEVICE_CONFIG_ID |
| dflet | 0:400d8e75a8d0 | 970 | - NETAPP_SET_GET_DEV_CONF_OPT_DEVICE_URN |
| dflet | 0:400d8e75a8d0 | 971 | - NETAPP_SET_GET_DEV_CONF_OPT_DOMAIN_NAME |
| dflet | 0:400d8e75a8d0 | 972 | |
| dflet | 0:400d8e75a8d0 | 973 | |
| dflet | 0:400d8e75a8d0 | 974 | \param[in] OptionLen option structure length |
| dflet | 0:400d8e75a8d0 | 975 | |
| dflet | 0:400d8e75a8d0 | 976 | \param[in] pOptionValues pointer to the option structure |
| dflet | 0:400d8e75a8d0 | 977 | \sa |
| dflet | 0:400d8e75a8d0 | 978 | \note |
| dflet | 0:400d8e75a8d0 | 979 | \warning |
| dflet | 0:400d8e75a8d0 | 980 | \par |
| dflet | 0:400d8e75a8d0 | 981 | \code |
| dflet | 0:400d8e75a8d0 | 982 | Set DHCP Server (AP mode) parameters example: |
| dflet | 0:400d8e75a8d0 | 983 | |
| dflet | 0:400d8e75a8d0 | 984 | SlNetAppDhcpServerBasicOpt_t dhcpParams; |
| dflet | 0:400d8e75a8d0 | 985 | uint8_t outLen = sizeof(SlNetAppDhcpServerBasicOpt_t); |
| dflet | 0:400d8e75a8d0 | 986 | dhcpParams.lease_time = 4096; // lease time (in seconds) of the IP Address |
| dflet | 0:400d8e75a8d0 | 987 | dhcpParams.ipv4_addr_start = SL_IPV4_VAL(192,168,1,10); // first IP Address for allocation. IP Address should be set as Hex number - i.e. 0A0B0C01 for (10.11.12.1) |
| dflet | 0:400d8e75a8d0 | 988 | dhcpParams.ipv4_addr_last = SL_IPV4_VAL(192,168,1,16); // last IP Address for allocation. IP Address should be set as Hex number - i.e. 0A0B0C01 for (10.11.12.1) |
| dflet | 0:400d8e75a8d0 | 989 | sl_NetAppStop(SL_NET_APP_DHCP_SERVER_ID); // Stop DHCP server before settings |
| dflet | 0:400d8e75a8d0 | 990 | sl_NetAppSet(SL_NET_APP_DHCP_SERVER_ID, NETAPP_SET_DHCP_SRV_BASIC_OPT, outLen, (uint8_t* )&dhcpParams); // set parameters |
| dflet | 0:400d8e75a8d0 | 991 | sl_NetAppStart(SL_NET_APP_DHCP_SERVER_ID); // Start DHCP server with new settings |
| dflet | 0:400d8e75a8d0 | 992 | \endcode |
| dflet | 0:400d8e75a8d0 | 993 | \code |
| dflet | 0:400d8e75a8d0 | 994 | Set Device URN name example: |
| dflet | 0:400d8e75a8d0 | 995 | |
| dflet | 0:400d8e75a8d0 | 996 | Device name, maximum length of 33 characters |
| dflet | 0:400d8e75a8d0 | 997 | Device name affects URN name, own SSID name in AP mode, and WPS file "device name" in WPS I.E (STA-WPS / P2P) |
| dflet | 0:400d8e75a8d0 | 998 | In case no device URN name set, the default name is "mysimplelink" |
| dflet | 0:400d8e75a8d0 | 999 | Allowed characters in device name are: 'a - z' , 'A - Z' , '0-9' and '-' |
| dflet | 0:400d8e75a8d0 | 1000 | |
| dflet | 0:400d8e75a8d0 | 1001 | uint8_t *my_device = "MY-SIMPLELINK-DEV"; |
| dflet | 0:400d8e75a8d0 | 1002 | sl_NetAppSet (SL_NET_APP_DEVICE_CONFIG_ID, NETAPP_SET_GET_DEV_CONF_OPT_DEVICE_URN, strlen(my_device), (uint8_t *) my_device); |
| dflet | 0:400d8e75a8d0 | 1003 | \endcode |
| dflet | 0:400d8e75a8d0 | 1004 | |
| dflet | 0:400d8e75a8d0 | 1005 | */ |
| dflet | 0:400d8e75a8d0 | 1006 | #if _SL_INCLUDE_FUNC(sl_NetAppSet) |
| dflet | 0:400d8e75a8d0 | 1007 | int32_t sl_NetAppSet(const uint8_t AppId, const uint8_t Option, const uint8_t OptionLen, const uint8_t *pOptionValue); |
| dflet | 0:400d8e75a8d0 | 1008 | #endif |
| dflet | 0:400d8e75a8d0 | 1009 | |
| dflet | 0:400d8e75a8d0 | 1010 | /*! |
| dflet | 0:400d8e75a8d0 | 1011 | \brief Internal function for getting network applications configurations |
| dflet | 0:400d8e75a8d0 | 1012 | |
| dflet | 0:400d8e75a8d0 | 1013 | \return On success, zero is returned. On error, -1 is |
| dflet | 0:400d8e75a8d0 | 1014 | returned |
| dflet | 0:400d8e75a8d0 | 1015 | |
| dflet | 0:400d8e75a8d0 | 1016 | \param[in] AppId Application id, could be one of the following: \n |
| dflet | 0:400d8e75a8d0 | 1017 | - SL_NET_APP_HTTP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 1018 | - SL_NET_APP_DHCP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 1019 | - SL_NET_APP_MDNS_ID |
| dflet | 0:400d8e75a8d0 | 1020 | - SL_NET_APP_DEVICE_CONFIG_ID |
| dflet | 0:400d8e75a8d0 | 1021 | |
| dflet | 0:400d8e75a8d0 | 1022 | \param[in] SetOptions set option, could be one of the following: \n |
| dflet | 0:400d8e75a8d0 | 1023 | - SL_NET_APP_DHCP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 1024 | - NETAPP_SET_DHCP_SRV_BASIC_OPT |
| dflet | 0:400d8e75a8d0 | 1025 | - SL_NET_APP_HTTP_SERVER_ID |
| dflet | 0:400d8e75a8d0 | 1026 | - NETAPP_SET_GET_HTTP_OPT_PORT_NUMBER |
| dflet | 0:400d8e75a8d0 | 1027 | - NETAPP_SET_GET_HTTP_OPT_AUTH_CHECK |
| dflet | 0:400d8e75a8d0 | 1028 | - NETAPP_SET_GET_HTTP_OPT_AUTH_NAME |
| dflet | 0:400d8e75a8d0 | 1029 | - NETAPP_SET_GET_HTTP_OPT_AUTH_PASSWORD |
| dflet | 0:400d8e75a8d0 | 1030 | - NETAPP_SET_GET_HTTP_OPT_AUTH_REALM |
| dflet | 0:400d8e75a8d0 | 1031 | - NETAPP_SET_GET_HTTP_OPT_ROM_PAGES_ACCESS |
| dflet | 0:400d8e75a8d0 | 1032 | - SL_NET_APP_MDNS_ID |
| dflet | 0:400d8e75a8d0 | 1033 | - NETAPP_SET_GET_MDNS_CONT_QUERY_OPT |
| dflet | 0:400d8e75a8d0 | 1034 | - NETAPP_SET_GET_MDNS_QEVETN_MASK_OPT |
| dflet | 0:400d8e75a8d0 | 1035 | - NETAPP_SET_GET_MDNS_TIMING_PARAMS_OPT |
| dflet | 0:400d8e75a8d0 | 1036 | - SL_NET_APP_DEVICE_CONFIG_ID |
| dflet | 0:400d8e75a8d0 | 1037 | - NETAPP_SET_GET_DEV_CONF_OPT_DEVICE_URN |
| dflet | 0:400d8e75a8d0 | 1038 | - NETAPP_SET_GET_DEV_CONF_OPT_DOMAIN_NAME |
| dflet | 0:400d8e75a8d0 | 1039 | |
| dflet | 0:400d8e75a8d0 | 1040 | \param[in] OptionLen The length of the allocated memory as input, when the |
| dflet | 0:400d8e75a8d0 | 1041 | function complete, the value of this parameter would be |
| dflet | 0:400d8e75a8d0 | 1042 | the len that actually read from the device. |
| dflet | 0:400d8e75a8d0 | 1043 | If the device return length that is longer from the input |
| dflet | 0:400d8e75a8d0 | 1044 | value, the function will cut the end of the returned structure |
| dflet | 0:400d8e75a8d0 | 1045 | and will return ESMALLBUF |
| dflet | 0:400d8e75a8d0 | 1046 | |
| dflet | 0:400d8e75a8d0 | 1047 | \param[out] pValues pointer to the option structure which will be filled with the response from the device |
| dflet | 0:400d8e75a8d0 | 1048 | |
| dflet | 0:400d8e75a8d0 | 1049 | \sa |
| dflet | 0:400d8e75a8d0 | 1050 | \note |
| dflet | 0:400d8e75a8d0 | 1051 | \warning |
| dflet | 0:400d8e75a8d0 | 1052 | \par |
| dflet | 0:400d8e75a8d0 | 1053 | \code |
| dflet | 0:400d8e75a8d0 | 1054 | Get DHCP Server parameters example: |
| dflet | 0:400d8e75a8d0 | 1055 | |
| dflet | 0:400d8e75a8d0 | 1056 | SlNetAppDhcpServerBasicOpt_t dhcpParams; |
| dflet | 0:400d8e75a8d0 | 1057 | uint8_t outLen = sizeof(SlNetAppDhcpServerBasicOpt_t); |
| dflet | 0:400d8e75a8d0 | 1058 | sl_NetAppGet(SL_NET_APP_DHCP_SERVER_ID, NETAPP_SET_DHCP_SRV_BASIC_OPT, &outLen, (uint8_t* )&dhcpParams); |
| dflet | 0:400d8e75a8d0 | 1059 | |
| dflet | 0:400d8e75a8d0 | 1060 | printf("DHCP Start IP %d.%d.%d.%d End IP %d.%d.%d.%d Lease time seconds %d\n", |
| dflet | 0:400d8e75a8d0 | 1061 | SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,3),SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,2), |
| dflet | 0:400d8e75a8d0 | 1062 | SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,1),SL_IPV4_BYTE(dhcpParams.ipv4_addr_start,0), |
| dflet | 0:400d8e75a8d0 | 1063 | SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,3),SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,2), |
| dflet | 0:400d8e75a8d0 | 1064 | SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,1),SL_IPV4_BYTE(dhcpParams.ipv4_addr_last,0), |
| dflet | 0:400d8e75a8d0 | 1065 | dhcpParams.lease_time); |
| dflet | 0:400d8e75a8d0 | 1066 | \endcode |
| dflet | 0:400d8e75a8d0 | 1067 | \code |
| dflet | 0:400d8e75a8d0 | 1068 | Get Device URN name example: |
| dflet | 0:400d8e75a8d0 | 1069 | Maximum length of 33 characters of device name. |
| dflet | 0:400d8e75a8d0 | 1070 | Device name affects URN name, own SSID name in AP mode, and WPS file "device name" in WPS I.E (STA-WPS / P2P) |
| dflet | 0:400d8e75a8d0 | 1071 | in case no device URN name set, the default name is "mysimplelink" |
| dflet | 0:400d8e75a8d0 | 1072 | |
| dflet | 0:400d8e75a8d0 | 1073 | uint8_t my_device_name[35]; |
| dflet | 0:400d8e75a8d0 | 1074 | sl_NetAppGet (SL_NET_APP_DEVICE_CONFIG_ID, NETAPP_SET_GET_DEV_CONF_OPT_DEVICE_URN, strlen(my_device_name), (uint8_t *)my_device_name); |
| dflet | 0:400d8e75a8d0 | 1075 | \endcode |
| dflet | 0:400d8e75a8d0 | 1076 | */ |
| dflet | 0:400d8e75a8d0 | 1077 | #if _SL_INCLUDE_FUNC(sl_NetAppGet) |
| dflet | 0:400d8e75a8d0 | 1078 | int32_t sl_NetAppGet(const uint8_t AppId, const uint8_t Option,uint8_t *pOptionLen, uint8_t *pOptionValue); |
| dflet | 0:400d8e75a8d0 | 1079 | #endif |
| dflet | 0:400d8e75a8d0 | 1080 | |
| dflet | 0:400d8e75a8d0 | 1081 | private: |
| dflet | 0:400d8e75a8d0 | 1082 | |
| dflet | 0:400d8e75a8d0 | 1083 | cc3100_driver &_driver; |
| dflet | 0:400d8e75a8d0 | 1084 | #ifndef SL_PLATFORM_MULTI_THREADED |
| dflet | 0:400d8e75a8d0 | 1085 | cc3100_nonos &_nonos; |
| dflet | 0:400d8e75a8d0 | 1086 | #endif |
| dflet | 0:400d8e75a8d0 | 1087 | |
| dflet | 0:400d8e75a8d0 | 1088 | };//class |
| dflet | 0:400d8e75a8d0 | 1089 | |
| dflet | 0:400d8e75a8d0 | 1090 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 1091 | /* Macro declarations */ |
| dflet | 0:400d8e75a8d0 | 1092 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 1093 | const uint8_t FLOW_CONT_MIN = 1; |
| dflet | 0:400d8e75a8d0 | 1094 | |
| dflet | 0:400d8e75a8d0 | 1095 | |
| dflet | 0:400d8e75a8d0 | 1096 | class cc3100_flowcont |
| dflet | 0:400d8e75a8d0 | 1097 | { |
| dflet | 0:400d8e75a8d0 | 1098 | |
| dflet | 0:400d8e75a8d0 | 1099 | public: |
| dflet | 0:400d8e75a8d0 | 1100 | |
| dflet | 0:400d8e75a8d0 | 1101 | #ifndef SL_PLATFORM_MULTI_THREADED |
| dflet | 0:400d8e75a8d0 | 1102 | cc3100_flowcont(cc3100_driver &driver, cc3100_nonos &nonos); |
| dflet | 0:400d8e75a8d0 | 1103 | #else |
| dflet | 0:400d8e75a8d0 | 1104 | cc3100_flowcont(cc3100_driver &driver); |
| dflet | 0:400d8e75a8d0 | 1105 | #endif |
| dflet | 0:400d8e75a8d0 | 1106 | |
| dflet | 0:400d8e75a8d0 | 1107 | ~cc3100_flowcont(); |
| dflet | 0:400d8e75a8d0 | 1108 | |
| dflet | 0:400d8e75a8d0 | 1109 | #if 0 |
| dflet | 0:400d8e75a8d0 | 1110 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 1111 | /* Function prototypes */ |
| dflet | 0:400d8e75a8d0 | 1112 | /*****************************************************************************/ |
| dflet | 0:400d8e75a8d0 | 1113 | void _SlDrvFlowContInit(void); |
| dflet | 0:400d8e75a8d0 | 1114 | void _SlDrvFlowContDeinit(void); |
| dflet | 0:400d8e75a8d0 | 1115 | #endif |
| dflet | 0:400d8e75a8d0 | 1116 | |
| dflet | 0:400d8e75a8d0 | 1117 | private: |
| dflet | 0:400d8e75a8d0 | 1118 | |
| dflet | 0:400d8e75a8d0 | 1119 | cc3100_driver &_driver; |
| dflet | 0:400d8e75a8d0 | 1120 | #ifndef SL_PLATFORM_MULTI_THREADED |
| dflet | 0:400d8e75a8d0 | 1121 | cc3100_nonos &_nonos; |
| dflet | 0:400d8e75a8d0 | 1122 | #endif |
| dflet | 0:400d8e75a8d0 | 1123 | |
| dflet | 0:400d8e75a8d0 | 1124 | };//class |
| dflet | 0:400d8e75a8d0 | 1125 | }//namespace mbed_cc3100 |
| dflet | 0:400d8e75a8d0 | 1126 | |
| dflet | 0:400d8e75a8d0 | 1127 | /*! |
| dflet | 0:400d8e75a8d0 | 1128 | |
| dflet | 0:400d8e75a8d0 | 1129 | Close the Doxygen group. |
| dflet | 0:400d8e75a8d0 | 1130 | @} |
| dflet | 0:400d8e75a8d0 | 1131 | |
| dflet | 0:400d8e75a8d0 | 1132 | */ |
| dflet | 0:400d8e75a8d0 | 1133 | |
| dflet | 0:400d8e75a8d0 | 1134 | #endif /* __NETAPP_H__ */ |
| dflet | 0:400d8e75a8d0 | 1135 | |
| dflet | 0:400d8e75a8d0 | 1136 |