1 /*
2  * This file is part of the MicroPython project, http://micropython.org/
3  *
4  * The MIT License (MIT)
5  *
6  * Copyright (c) 2013, 2014 Damien P. George
7  * Copyright (c) 2015 Daniel Campora
8  *
9  * Permission is hereby granted, free of charge, to any person obtaining a copy
10  * of this software and associated documentation files (the "Software"), to deal
11  * in the Software without restriction, including without limitation the rights
12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13  * copies of the Software, and to permit persons to whom the Software is
14  * furnished to do so, subject to the following conditions:
15  *
16  * The above copyright notice and this permission notice shall be included in
17  * all copies or substantial portions of the Software.
18  *
19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25  * THE SOFTWARE.
26  */
27 #ifndef MICROPY_INCLUDED_LIB_NETUTILS_NETUTILS_H
28 #define MICROPY_INCLUDED_LIB_NETUTILS_NETUTILS_H
29 
30 // Modified bt HaaS begin
31 #include "py/mpprint.h"
32 #include "py/obj.h"
33 // Modified bt HaaS end
34 
35 #define NETUTILS_IPV4ADDR_BUFSIZE    4
36 
37 #define NETUTILS_TRACE_IS_TX        (0x0001)
38 #define NETUTILS_TRACE_PAYLOAD      (0x0002)
39 #define NETUTILS_TRACE_NEWLINE      (0x0004)
40 
41 typedef enum _netutils_endian_t {
42     NETUTILS_LITTLE,
43     NETUTILS_BIG,
44 } netutils_endian_t;
45 
46 // Takes an array with a raw IPv4 address and returns something like '192.168.0.1'.
47 mp_obj_t netutils_format_ipv4_addr(uint8_t *ip, netutils_endian_t endian);
48 
49 // Takes an array with a raw IP address, and a port, and returns a net-address
50 // tuple such as ('192.168.0.1', 8080).
51 mp_obj_t netutils_format_inet_addr(uint8_t *ip, mp_uint_t port, netutils_endian_t endian);
52 
53 void netutils_parse_ipv4_addr(mp_obj_t addr_in, uint8_t *out_ip, netutils_endian_t endian);
54 
55 // Takes an address of the form ('192.168.0.1', 8080), returns the port and
56 // puts IP in out_ip (which must take at least IPADDR_BUF_SIZE bytes).
57 mp_uint_t netutils_parse_inet_addr(mp_obj_t addr_in, uint8_t *out_ip, netutils_endian_t endian);
58 
59 void netutils_ethernet_trace(const mp_print_t *print, size_t len, const uint8_t *buf, unsigned int flags);
60 
61 #endif // MICROPY_INCLUDED_LIB_NETUTILS_NETUTILS_H
62