SimpleLink API Reference Manual  1.11.1
•All Data Structures Files Functions Variables Typedefs Macros Groups
netapp.h
Go to the documentation of this file.
1 /*****************************************************************************
2 *
3 * netapp.h - CC3000 Host Driver Implementation.
4 * Copyright (C) 2011 Texas Instruments Incorporated - https://www.ti.com/
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the
16 * distribution.
17 *
18 * Neither the name of Texas Instruments Incorporated nor the names of
19 * its contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 *****************************************************************************/
35 #ifndef __NETAPP_H__
36 #define __NETAPP_H__
37 
38 
39 //*****************************************************************************
40 //
41 // If building with a C++ compiler, make all of the definitions in this header
42 // have a C binding.
43 //
44 //*****************************************************************************
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48 
49 //*****************************************************************************
50 //
53 //
54 //*****************************************************************************
55 
56 typedef struct _netapp_dhcp_ret_args_t
57 {
58  unsigned char aucIP[4];
59  unsigned char aucSubnetMask[4];
60  unsigned char aucDefaultGateway[4];
61  unsigned char aucDHCPServer[4];
62  unsigned char aucDNSServer[4];
63 }tNetappDhcpParams;
64 
65 typedef struct _netapp_ipconfig_ret_args_t
66 {
67  unsigned char aucIP[4];
68  unsigned char aucSubnetMask[4];
69  unsigned char aucDefaultGateway[4];
70  unsigned char aucDHCPServer[4];
71  unsigned char aucDNSServer[4];
72  unsigned char uaMacAddr[6];
73  unsigned char uaSSID[32];
74 }tNetappIpconfigRetArgs;
75 
76 
77 /*Ping send report parameters*/
78 typedef struct _netapp_pingreport_args
79 {
80  unsigned long packets_sent;
81  unsigned long packets_received;
82  unsigned long min_round_time;
83  unsigned long max_round_time;
84  unsigned long avg_round_time;
85 } netapp_pingreport_args_t;
86 
87 
88 //*****************************************************************************
89 //
100 //
101 //*****************************************************************************
102 extern long netapp_config_mac_adrress( unsigned char *mac );
103 
104 //*****************************************************************************
105 //
129 //*****************************************************************************
130 extern long netapp_dhcp(unsigned long *aucIP, unsigned long *aucSubnetMask,unsigned long *aucDefaultGateway, unsigned long *aucDNSServer);
131 
132 
133 
134 //*****************************************************************************
135 //
182 //*****************************************************************************
183  #ifndef CC3000_TINY_DRIVER
184 extern long netapp_timeout_values(unsigned long *aucDHCP, unsigned long *aucARP,unsigned long *aucKeepalive, unsigned long *aucInactivity);
185 #endif
186 
187 //*****************************************************************************
188 //
206 //*****************************************************************************
207 
208  #ifndef CC3000_TINY_DRIVER
209 extern long netapp_ping_send(unsigned long *ip, unsigned long ulPingAttempts, unsigned long ulPingSize, unsigned long ulPingTimeout);
210 #endif
211 
212 //*****************************************************************************
213 //
223 //*****************************************************************************
224 
225 #ifndef CC3000_TINY_DRIVER
226 extern long netapp_ping_stop();
227 #endif
228 //*****************************************************************************
229 //
249 //*****************************************************************************
250 #ifndef CC3000_TINY_DRIVER
251 extern void netapp_ping_report();
252 #endif
253 
254 
255 //*****************************************************************************
256 //
279 //*****************************************************************************
280 
281 extern void netapp_ipconfig( tNetappIpconfigRetArgs * ipconfig );
282 
283 
284 //*****************************************************************************
285 //
294 //*****************************************************************************
295 
296 #ifndef CC3000_TINY_DRIVER
297 extern long netapp_arp_flush();
298 #endif
299 
300 
301 //*****************************************************************************
302 //
317 //*****************************************************************************
318 
319 
320 #ifndef CC3000_TINY_DRIVER
321 long netapp_set_debug_level(unsigned long ulLevel);
322 #endif
323 //*****************************************************************************
324 //
325 // Close the Doxygen group.
327 //
328 //*****************************************************************************
329 
330 
331 
332 //*****************************************************************************
333 //
334 // Mark the end of the C bindings section for C++ compilers.
335 //
336 //*****************************************************************************
337 #ifdef __cplusplus
338 }
339 #endif // __cplusplus
340 
341 #endif // __NETAPP_H__
342