Update README.md
[oweals/nmrpflash.git] / nmrpd.h
1 /**
2  * nmrpflash - Netgear Unbrick Utility
3  * Copyright (C) 2016 Joseph Lehner <joseph.c.lehner@gmail.com>
4  *
5  * nmrpflash is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * nmrpflash is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with nmrpflash.  If not, see <http://www.gnu.org/licenses/>.
17  *
18  */
19
20 #ifndef NMRPD_H
21 #define NMRPD_H
22 #include <stdint.h>
23 #include <signal.h>
24 #include <stdbool.h>
25
26 #if defined(_WIN32) || defined(_WIN64)
27 #       define NMRPFLASH_WINDOWS
28 #elif defined(__APPLE__) && defined(__MACH__)
29 #       define NMRPFLASH_UNIX
30 #       define NMRPFLASH_OSX
31 #       define NMRPFLASH_BSD
32 #elif defined (__unix__)
33 #       define NMRPFLASH_UNIX
34 #       if defined(__linux__)
35 #               define NMRPFLASH_LINUX
36 #       elif defined(__FreeBSD__) || defined(__NetBSD__) || defined(__DragonFly__) || defined(__OpenBSD__)
37 #                       define NMRPFLASH_BSD
38 #       else
39 #               warning "nmrpflash is not fully supported on this platform"
40 #       endif
41 #else
42 #       warning "nmrpflash is not supported on this platform"
43 #endif
44
45 #ifndef NMRPFLASH_WINDOWS
46 #include <arpa/inet.h>
47 #include <sys/types.h>
48 #include <sys/socket.h>
49 #include <netinet/in.h>
50 #include <net/if.h>
51 #ifndef NMRPFLASH_LINUX
52 #include <net/if_dl.h>
53 #endif
54 #else
55 #include <winsock2.h>
56 #include <iphlpapi.h>
57 #include <ws2tcpip.h>
58 #include <windows.h>
59 #endif
60
61 #ifndef MIN
62 #define MIN(a, b) ((a) < (b) ? (a) : (b))
63 #endif
64
65 #ifndef MAX
66 #define MAX(a, b) ((a) > (b) ? (a) : (b))
67 #endif
68
69 #ifndef PACKED
70 #define PACKED __attribute__((packed))
71 #endif
72
73 #define NMRPFLASH_SET_REGION
74
75 struct eth_hdr {
76         uint8_t ether_dhost[6];
77         uint8_t ether_shost[6];
78         uint16_t ether_type;
79 } PACKED;
80
81 enum nmrp_op {
82         NMRP_UPLOAD_FW = 0,
83         NMRP_UPLOAD_ST = 1,
84         NMRP_SET_REGION = 2,
85 };
86
87 struct nmrpd_args {
88         unsigned rx_timeout;
89         unsigned ul_timeout;
90         const char *tftpcmd;
91         const char *file_local;
92         const char *file_remote;
93         const char *ipaddr_intf;
94         const char *ipaddr;
95         const char *ipmask;
96         const char *intf;
97         const char *mac;
98         enum nmrp_op op;
99         bool blind;
100         uint16_t port;
101         const char *region;
102 };
103
104 const char *leafname(const char *path);
105 int tftp_put(struct nmrpd_args *args);
106 bool tftp_is_valid_filename(const char *filename);
107
108 int nmrp_do(struct nmrpd_args *args);
109
110 int select_fd(int fd, unsigned timeout);
111 const char *mac_to_str(uint8_t *mac);
112
113 #ifdef NMRPFLASH_WINDOWS
114 void win_perror2(const char *msg, DWORD err);
115 void sock_perror(const char *msg);
116 #else
117 #define sock_perror(x) xperror(x)
118 #endif
119
120 extern int verbosity;
121
122 struct ethsock;
123 struct ethsock_arp_undo;
124 struct ethsock_ip_undo;
125
126 struct ethsock *ethsock_create(const char *intf, uint16_t protocol);
127 int ethsock_close(struct ethsock *sock);
128 int ethsock_send(struct ethsock *sock, void *buf, size_t len);
129 ssize_t ethsock_recv(struct ethsock *sock, void *buf, size_t len);
130 int ethsock_set_timeout(struct ethsock *sock, unsigned msec);
131 uint8_t *ethsock_get_hwaddr(struct ethsock *sock);
132 int ethsock_arp_add(struct ethsock *sock, uint8_t *hwaddr, uint32_t ipaddr, struct ethsock_arp_undo **undo);
133 int ethsock_arp_del(struct ethsock *sock, struct ethsock_arp_undo **undo);
134 int ethsock_list_all(void);
135
136 struct ethsock_ip_callback_args
137 {
138         struct in_addr *ipaddr;
139         struct in_addr *ipmask;
140         void *arg;
141 };
142
143 typedef int (*ethsock_ip_callback_t)(struct ethsock_ip_callback_args *args);
144 int ethsock_for_each_ip(struct ethsock *sock, ethsock_ip_callback_t callback,
145                 void *arg);
146
147 int ethsock_ip_add(struct ethsock *sock, uint32_t ipaddr, uint32_t ipmask, struct ethsock_ip_undo **undo);
148 int ethsock_ip_del(struct ethsock *sock, struct ethsock_ip_undo **undo);
149
150 time_t time_monotonic();
151 char *lltostr(long long ll, int base);
152 uint32_t bitcount(uint32_t n);
153 uint32_t netmask(uint32_t count);
154 void xperror(const char *msg);
155
156 extern volatile sig_atomic_t g_interrupted;
157 #endif