2014-09-30 21:29:49 +00:00
|
|
|
/*
|
2017-06-30 07:22:17 +00:00
|
|
|
* This file is part of the MicroPython project, http://micropython.org/
|
2014-09-30 21:29:49 +00:00
|
|
|
*
|
|
|
|
* The MIT License (MIT)
|
|
|
|
*
|
|
|
|
* Copyright (c) 2013, 2014 Damien P. George
|
|
|
|
*
|
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
|
|
* in the Software without restriction, including without limitation the rights
|
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
|
|
* furnished to do so, subject to the following conditions:
|
|
|
|
*
|
|
|
|
* The above copyright notice and this permission notice shall be included in
|
|
|
|
* all copies or substantial portions of the Software.
|
|
|
|
*
|
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
|
|
* THE SOFTWARE.
|
|
|
|
*/
|
2021-09-14 18:33:53 +00:00
|
|
|
#ifndef MICROPY_INCLUDED_MODNETWORK_H
|
|
|
|
#define MICROPY_INCLUDED_MODNETWORK_H
|
2014-09-30 21:29:49 +00:00
|
|
|
|
|
|
|
#define MOD_NETWORK_IPADDR_BUF_SIZE (4)
|
|
|
|
|
|
|
|
#define MOD_NETWORK_AF_INET (2)
|
|
|
|
#define MOD_NETWORK_AF_INET6 (10)
|
|
|
|
|
|
|
|
#define MOD_NETWORK_SOCK_STREAM (1)
|
|
|
|
#define MOD_NETWORK_SOCK_DGRAM (2)
|
|
|
|
#define MOD_NETWORK_SOCK_RAW (3)
|
|
|
|
|
2021-08-22 15:27:38 +00:00
|
|
|
#define MOD_NETWORK_STA_IF (0)
|
|
|
|
#define MOD_NETWORK_AP_IF (1)
|
|
|
|
|
2022-01-15 19:32:53 +00:00
|
|
|
// Socket level option.
|
|
|
|
#define MOD_NETWORK_SOL_SOCKET (0x0FFF)
|
|
|
|
|
|
|
|
// Common option flags per-socket.
|
|
|
|
#define MOD_NETWORK_SO_REUSEADDR (0x0004)
|
2023-06-19 02:09:59 +00:00
|
|
|
#define MOD_NETWORK_SO_BROADCAST (0x0020)
|
2022-01-15 19:32:53 +00:00
|
|
|
#define MOD_NETWORK_SO_KEEPALIVE (0x0008)
|
|
|
|
#define MOD_NETWORK_SO_SNDTIMEO (0x1005)
|
|
|
|
#define MOD_NETWORK_SO_RCVTIMEO (0x1006)
|
|
|
|
|
2022-06-07 15:23:59 +00:00
|
|
|
#define MOD_NETWORK_SS_NEW (0)
|
|
|
|
#define MOD_NETWORK_SS_LISTENING (1)
|
|
|
|
#define MOD_NETWORK_SS_CONNECTED (2)
|
|
|
|
#define MOD_NETWORK_SS_CLOSED (3)
|
|
|
|
|
2023-02-01 03:19:45 +00:00
|
|
|
extern char mod_network_country_code[2];
|
|
|
|
|
|
|
|
#ifndef MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN
|
2023-09-29 12:49:49 +00:00
|
|
|
// Doesn't include the null terminator.
|
|
|
|
#define MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN (32)
|
2023-02-01 03:19:45 +00:00
|
|
|
#endif
|
|
|
|
|
2023-09-29 12:49:49 +00:00
|
|
|
// This is a null-terminated string.
|
2023-10-03 02:32:48 +00:00
|
|
|
extern char mod_network_hostname_data[MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN + 1];
|
|
|
|
|
|
|
|
// To support backwards-compatible (esp32, esp8266, cyw43)
|
|
|
|
// `if.config(hostname=...)` to forward directly to the implementation of
|
|
|
|
// `network.hostname(...)`.
|
|
|
|
mp_obj_t mod_network_hostname(size_t n_args, const mp_obj_t *args);
|
2023-02-01 03:19:45 +00:00
|
|
|
|
2018-05-21 06:48:24 +00:00
|
|
|
#if MICROPY_PY_LWIP
|
extmod/modnetwork: Implement IPv6 API to set and get NIC configuration.
This commit implements a new <AbstractNIC>.ipconfig() function for the NIC
classes that use lwIP, to set and retrieve network configuration for a NIC.
Currently this method supports:
- ipconfig("addr4"): obtain a tuple (addr, netmask) of the currently
configured ipv4 address
- ipconfig("addr6"): obtain a list of tuples (addr, state,
prefered_lifetime, valid_lifetime) of all currently active ipv6
addresses; this includes static, slaac and link-local addresses
- ipconfig("has_dhcp4"): whether ipv4 dhcp has supplied an address
- ipconfig("has_autoconf6"): if there is a valid, non-static ipv6 address
- ipconfig(addr4="1.2.3.4/24"): to set the ipv4 address and netmask
- ipconfig(addr6="2a01::2"): to set a static ipv6 address; note that this
does not configure an interface route, as this does not seem supported by
lwIP
- ipconfig(autoconf6=True): to enable ipv6 network configuration with slaac
- ipconfig(gw4="1.2.3.1"): to set the ipv4 gateway
- ipconfig(dhcp4=True): enable ipv4 dhcp; this sets ipv4 address, netmask,
gateway and a dns server
- ipconfig(dhcp4=False): stops dhcp, releases the ip, and clears the
configured ipv4 address.
- ipconfig(dhcp6=True): enable stateless dhcpv6 to obtain a dns server
There is also a new global configuration function network.ipconfig() that
supports the following:
- network.ipconfig(dns="2a01::2"): set the primary dns server (can be a
ipv4 or ipv6 address)
- network.ipconfig(prefer=6): to prefer ipv6 addresses to be returned as
dns responses (falling back to ipv4 if the host does not have an ipv6
address); note that this does not flush the dns cache, so if a host is
already in the dns cache with its v4 address, subsequent lookups will
return that address even if prefer=6 is set
This interface replaces NIC.ifconfig() completely, and ifconfig() should be
marked as deprecated and removed in a future version.
Signed-off-by: Felix Dörre <felix@dogcraft.de>
2023-10-10 16:13:24 +00:00
|
|
|
|
|
|
|
#include "lwip/init.h"
|
|
|
|
|
2018-05-21 06:48:24 +00:00
|
|
|
struct netif;
|
2022-05-05 02:32:22 +00:00
|
|
|
void mod_network_lwip_init(void);
|
2019-02-08 04:52:56 +00:00
|
|
|
void mod_network_lwip_poll_wrapper(uint32_t ticks_ms);
|
2018-06-01 03:33:14 +00:00
|
|
|
mp_obj_t mod_network_nic_ifconfig(struct netif *netif, size_t n_args, const mp_obj_t *args);
|
extmod/modnetwork: Implement IPv6 API to set and get NIC configuration.
This commit implements a new <AbstractNIC>.ipconfig() function for the NIC
classes that use lwIP, to set and retrieve network configuration for a NIC.
Currently this method supports:
- ipconfig("addr4"): obtain a tuple (addr, netmask) of the currently
configured ipv4 address
- ipconfig("addr6"): obtain a list of tuples (addr, state,
prefered_lifetime, valid_lifetime) of all currently active ipv6
addresses; this includes static, slaac and link-local addresses
- ipconfig("has_dhcp4"): whether ipv4 dhcp has supplied an address
- ipconfig("has_autoconf6"): if there is a valid, non-static ipv6 address
- ipconfig(addr4="1.2.3.4/24"): to set the ipv4 address and netmask
- ipconfig(addr6="2a01::2"): to set a static ipv6 address; note that this
does not configure an interface route, as this does not seem supported by
lwIP
- ipconfig(autoconf6=True): to enable ipv6 network configuration with slaac
- ipconfig(gw4="1.2.3.1"): to set the ipv4 gateway
- ipconfig(dhcp4=True): enable ipv4 dhcp; this sets ipv4 address, netmask,
gateway and a dns server
- ipconfig(dhcp4=False): stops dhcp, releases the ip, and clears the
configured ipv4 address.
- ipconfig(dhcp6=True): enable stateless dhcpv6 to obtain a dns server
There is also a new global configuration function network.ipconfig() that
supports the following:
- network.ipconfig(dns="2a01::2"): set the primary dns server (can be a
ipv4 or ipv6 address)
- network.ipconfig(prefer=6): to prefer ipv6 addresses to be returned as
dns responses (falling back to ipv4 if the host does not have an ipv6
address); note that this does not flush the dns cache, so if a host is
already in the dns cache with its v4 address, subsequent lookups will
return that address even if prefer=6 is set
This interface replaces NIC.ifconfig() completely, and ifconfig() should be
marked as deprecated and removed in a future version.
Signed-off-by: Felix Dörre <felix@dogcraft.de>
2023-10-10 16:13:24 +00:00
|
|
|
#if LWIP_VERSION_MAJOR >= 2
|
|
|
|
mp_obj_t mod_network_ipconfig(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs);
|
|
|
|
mp_obj_t mod_network_nic_ipconfig(struct netif *netif, size_t n_args, const mp_obj_t *args, mp_map_t *kwargs);
|
|
|
|
extern int mp_mod_network_prefer_dns_use_ip_version;
|
|
|
|
#endif
|
2023-02-01 03:19:45 +00:00
|
|
|
#elif defined(MICROPY_PORT_NETWORK_INTERFACES)
|
2018-05-21 06:48:24 +00:00
|
|
|
|
2014-11-29 13:48:45 +00:00
|
|
|
struct _mod_network_socket_obj_t;
|
|
|
|
|
2022-12-14 05:29:30 +00:00
|
|
|
typedef struct _mod_network_nic_protocol_t {
|
2014-11-29 13:48:45 +00:00
|
|
|
// API for non-socket operations
|
2014-09-30 21:29:49 +00:00
|
|
|
int (*gethostbyname)(mp_obj_t nic, const char *name, mp_uint_t len, uint8_t *ip_out);
|
2023-11-02 08:10:38 +00:00
|
|
|
void (*deinit)(void);
|
2014-11-29 13:48:45 +00:00
|
|
|
|
|
|
|
// API for socket operations; return -1 on error
|
|
|
|
int (*socket)(struct _mod_network_socket_obj_t *socket, int *_errno);
|
|
|
|
void (*close)(struct _mod_network_socket_obj_t *socket);
|
|
|
|
int (*bind)(struct _mod_network_socket_obj_t *socket, byte *ip, mp_uint_t port, int *_errno);
|
|
|
|
int (*listen)(struct _mod_network_socket_obj_t *socket, mp_int_t backlog, int *_errno);
|
|
|
|
int (*accept)(struct _mod_network_socket_obj_t *socket, struct _mod_network_socket_obj_t *socket2, byte *ip, mp_uint_t *port, int *_errno);
|
|
|
|
int (*connect)(struct _mod_network_socket_obj_t *socket, byte *ip, mp_uint_t port, int *_errno);
|
|
|
|
mp_uint_t (*send)(struct _mod_network_socket_obj_t *socket, const byte *buf, mp_uint_t len, int *_errno);
|
|
|
|
mp_uint_t (*recv)(struct _mod_network_socket_obj_t *socket, byte *buf, mp_uint_t len, int *_errno);
|
|
|
|
mp_uint_t (*sendto)(struct _mod_network_socket_obj_t *socket, const byte *buf, mp_uint_t len, byte *ip, mp_uint_t port, int *_errno);
|
|
|
|
mp_uint_t (*recvfrom)(struct _mod_network_socket_obj_t *socket, byte *buf, mp_uint_t len, byte *ip, mp_uint_t *port, int *_errno);
|
|
|
|
int (*setsockopt)(struct _mod_network_socket_obj_t *socket, mp_uint_t level, mp_uint_t opt, const void *optval, mp_uint_t optlen, int *_errno);
|
|
|
|
int (*settimeout)(struct _mod_network_socket_obj_t *socket, mp_uint_t timeout_ms, int *_errno);
|
|
|
|
int (*ioctl)(struct _mod_network_socket_obj_t *socket, mp_uint_t request, mp_uint_t arg, int *_errno);
|
2022-12-14 05:29:30 +00:00
|
|
|
} mod_network_nic_protocol_t;
|
2014-09-30 21:29:49 +00:00
|
|
|
|
2014-11-29 13:48:45 +00:00
|
|
|
typedef struct _mod_network_socket_obj_t {
|
|
|
|
mp_obj_base_t base;
|
|
|
|
mp_obj_t nic;
|
2022-12-14 05:29:30 +00:00
|
|
|
mod_network_nic_protocol_t *nic_protocol;
|
2021-09-14 19:21:09 +00:00
|
|
|
uint32_t domain : 5;
|
|
|
|
uint32_t type : 5;
|
|
|
|
uint32_t proto : 5;
|
|
|
|
uint32_t bound : 1;
|
|
|
|
int32_t fileno : 16;
|
2022-05-19 06:11:45 +00:00
|
|
|
int32_t timeout;
|
|
|
|
mp_obj_t callback;
|
2022-06-07 15:23:59 +00:00
|
|
|
int32_t state : 8;
|
2022-08-18 05:01:26 +00:00
|
|
|
#if MICROPY_PY_SOCKET_EXTENDED_STATE
|
2021-08-22 15:29:35 +00:00
|
|
|
// Extended socket state for NICs/ports that need it.
|
2022-06-07 15:23:59 +00:00
|
|
|
void *_private;
|
2021-08-22 15:29:35 +00:00
|
|
|
#endif
|
2014-11-29 13:48:45 +00:00
|
|
|
} mod_network_socket_obj_t;
|
|
|
|
|
2023-02-01 03:19:45 +00:00
|
|
|
#endif // MICROPY_PY_LWIP / MICROPY_PORT_NETWORK_INTERFACES
|
2018-06-01 03:31:28 +00:00
|
|
|
|
2023-02-01 03:19:45 +00:00
|
|
|
#ifdef MICROPY_PORT_NETWORK_INTERFACES
|
2014-09-30 21:29:49 +00:00
|
|
|
void mod_network_init(void);
|
2018-05-21 06:48:24 +00:00
|
|
|
void mod_network_deinit(void);
|
2014-09-30 21:29:49 +00:00
|
|
|
void mod_network_register_nic(mp_obj_t nic);
|
2014-11-29 13:48:45 +00:00
|
|
|
mp_obj_t mod_network_find_nic(const uint8_t *ip);
|
2023-02-01 03:19:45 +00:00
|
|
|
#endif
|
all: Unify header guard usage.
The code conventions suggest using header guards, but do not define how
those should look like and instead point to existing files. However, not
all existing files follow the same scheme, sometimes omitting header guards
altogether, sometimes using non-standard names, making it easy to
accidentally pick a "wrong" example.
This commit ensures that all header files of the MicroPython project (that
were not simply copied from somewhere else) follow the same pattern, that
was already present in the majority of files, especially in the py folder.
The rules are as follows.
Naming convention:
* start with the words MICROPY_INCLUDED
* contain the full path to the file
* replace special characters with _
In addition, there are no empty lines before #ifndef, between #ifndef and
one empty line before #endif. #endif is followed by a comment containing
the name of the guard macro.
py/grammar.h cannot use header guards by design, since it has to be
included multiple times in a single C file. Several other files also do not
need header guards as they are only used internally and guaranteed to be
included only once:
* MICROPY_MPHALPORT_H
* mpconfigboard.h
* mpconfigport.h
* mpthreadport.h
* pin_defs_*.h
* qstrdefs*.h
2017-06-29 21:14:58 +00:00
|
|
|
|
2021-09-14 18:33:53 +00:00
|
|
|
#endif // MICROPY_INCLUDED_MODNETWORK_H
|