blob: c2ce4a80d120c3e71bf2d63f6d73140b7e5ed566 [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenkb8fb6192004-08-02 21:11:11 +00002/*
3 * (C) Copyright 2004
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
wdenkb8fb6192004-08-02 21:11:11 +00005 */
6
wdenkb8fb6192004-08-02 21:11:11 +00007#include <command.h>
Simon Glass2d85a752019-08-01 09:46:41 -06008#include <env.h>
Simon Glass0f2af882020-05-10 11:40:05 -06009#include <log.h>
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +020010#include <stdio_dev.h>
wdenkb8fb6192004-08-02 21:11:11 +000011#include <net.h>
Tom Rinidec7ea02024-05-20 13:35:03 -060012#include <vsprintf.h>
wdenkb8fb6192004-08-02 21:11:11 +000013
Tom Rini364d0022023-01-10 11:19:45 -050014#ifndef CFG_NETCONSOLE_BUFFER_SIZE
15#define CFG_NETCONSOLE_BUFFER_SIZE 512
Joe Hershberger45f4a232012-07-31 06:09:17 +000016#endif
17
Tom Rini364d0022023-01-10 11:19:45 -050018static char input_buffer[CFG_NETCONSOLE_BUFFER_SIZE];
Joe Hershberger107b3d02012-05-15 08:59:13 +000019static int input_size; /* char count in input buffer */
20static int input_offset; /* offset to valid chars in input buffer */
21static int input_recursion;
22static int output_recursion;
wdenkb8fb6192004-08-02 21:11:11 +000023static int net_timeout;
Joe Hershberger107b3d02012-05-15 08:59:13 +000024static uchar nc_ether[6]; /* server enet address */
Joe Hershberger5874dec2015-04-08 01:41:01 -050025static struct in_addr nc_ip; /* server ip */
Joe Hershbergerd0f53962012-07-31 06:06:41 +000026static short nc_out_port; /* target output port */
27static short nc_in_port; /* source input port */
Joe Hershberger107b3d02012-05-15 08:59:13 +000028static const char *output_packet; /* used by first send udp */
29static int output_packet_len;
Joe Hershberger9f374062012-08-03 10:59:08 +000030/*
31 * Start with a default last protocol.
32 * We are only interested in NETCONS or not.
33 */
34enum proto_t net_loop_last_protocol = BOOTP;
wdenkb8fb6192004-08-02 21:11:11 +000035
Luca Ceresoli428ab362011-04-18 06:19:50 +000036static void nc_wait_arp_handler(uchar *pkt, unsigned dest,
Joe Hershberger5874dec2015-04-08 01:41:01 -050037 struct in_addr sip, unsigned src,
wdenkb8fb6192004-08-02 21:11:11 +000038 unsigned len)
39{
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +000040 net_set_state(NETLOOP_SUCCESS); /* got arp reply - quit net loop */
wdenkb8fb6192004-08-02 21:11:11 +000041}
42
Joe Hershberger5874dec2015-04-08 01:41:01 -050043static void nc_handler(uchar *pkt, unsigned dest, struct in_addr sip,
44 unsigned src, unsigned len)
wdenkb8fb6192004-08-02 21:11:11 +000045{
wdenka0ebde52004-09-08 22:03:11 +000046 if (input_size)
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +000047 net_set_state(NETLOOP_SUCCESS); /* got input - quit net loop */
wdenkb8fb6192004-08-02 21:11:11 +000048}
49
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -050050static void nc_timeout_handler(void)
wdenkb8fb6192004-08-02 21:11:11 +000051{
Joe Hershbergerd4bb76a2012-05-23 07:59:14 +000052 net_set_state(NETLOOP_SUCCESS);
wdenkb8fb6192004-08-02 21:11:11 +000053}
54
Joe Hershberger5874dec2015-04-08 01:41:01 -050055static int is_broadcast(struct in_addr ip)
Joe Hershberger66257802012-09-18 10:01:31 +000056{
Joe Hershberger5874dec2015-04-08 01:41:01 -050057 static struct in_addr netmask;
58 static struct in_addr our_ip;
Joe Hershberger66257802012-09-18 10:01:31 +000059 static int env_changed_id;
Simon Glass2d85a752019-08-01 09:46:41 -060060 int env_id = env_get_id();
Joe Hershberger66257802012-09-18 10:01:31 +000061
62 /* update only when the environment has changed */
63 if (env_changed_id != env_id) {
Tom Rini82a25102025-05-15 17:31:30 -060064 netmask = string_to_ip(env_get("netmask"));
65 our_ip = string_to_ip(env_get("ipaddr"));
Joe Hershberger66257802012-09-18 10:01:31 +000066
67 env_changed_id = env_id;
68 }
69
Joe Hershberger5874dec2015-04-08 01:41:01 -050070 return (ip.s_addr == ~0 || /* 255.255.255.255 (global bcast) */
71 ((netmask.s_addr & our_ip.s_addr) ==
72 (netmask.s_addr & ip.s_addr) && /* on the same net and */
73 (netmask.s_addr | ip.s_addr) == ~0)); /* bcast to our net */
Joe Hershberger66257802012-09-18 10:01:31 +000074}
75
76static int refresh_settings_from_env(void)
77{
78 const char *p;
79 static int env_changed_id;
Simon Glass2d85a752019-08-01 09:46:41 -060080 int env_id = env_get_id();
Joe Hershberger66257802012-09-18 10:01:31 +000081
82 /* update only when the environment has changed */
83 if (env_changed_id != env_id) {
Tom Rini82a25102025-05-15 17:31:30 -060084 char *tmp = env_get("ncip");
85 if (tmp) {
86 nc_ip = string_to_ip(tmp);
Joe Hershberger5874dec2015-04-08 01:41:01 -050087 if (!nc_ip.s_addr)
Joe Hershberger66257802012-09-18 10:01:31 +000088 return -1; /* ncip is 0.0.0.0 */
Tom Rini82a25102025-05-15 17:31:30 -060089 p = strchr(tmp, ':');
Joe Hershberger66257802012-09-18 10:01:31 +000090 if (p != NULL) {
Simon Glassff9b9032021-07-24 09:03:30 -060091 nc_out_port = dectoul(p + 1, NULL);
Joe Hershberger66257802012-09-18 10:01:31 +000092 nc_in_port = nc_out_port;
93 }
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -050094 } else {
Joe Hershberger5874dec2015-04-08 01:41:01 -050095 nc_ip.s_addr = ~0; /* ncip is not set, so broadcast */
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -050096 }
Joe Hershberger66257802012-09-18 10:01:31 +000097
Simon Glass64b723f2017-08-03 12:22:12 -060098 p = env_get("ncoutport");
Joe Hershberger66257802012-09-18 10:01:31 +000099 if (p != NULL)
Simon Glassff9b9032021-07-24 09:03:30 -0600100 nc_out_port = dectoul(p, NULL);
Simon Glass64b723f2017-08-03 12:22:12 -0600101 p = env_get("ncinport");
Joe Hershberger66257802012-09-18 10:01:31 +0000102 if (p != NULL)
Simon Glassff9b9032021-07-24 09:03:30 -0600103 nc_in_port = dectoul(p, NULL);
Joe Hershberger66257802012-09-18 10:01:31 +0000104
105 if (is_broadcast(nc_ip))
106 /* broadcast MAC address */
107 memset(nc_ether, 0xff, sizeof(nc_ether));
108 else
109 /* force arp request */
110 memset(nc_ether, 0, sizeof(nc_ether));
111 }
112 return 0;
113}
114
115/**
Joe Hershbergerc80b41b02015-04-08 01:41:21 -0500116 * Called from net_loop in net/net.c before each packet
Joe Hershberger66257802012-09-18 10:01:31 +0000117 */
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500118void nc_start(void)
wdenkb8fb6192004-08-02 21:11:11 +0000119{
Joe Hershberger66257802012-09-18 10:01:31 +0000120 refresh_settings_from_env();
Joe Hershberger8ecdbed2015-04-08 01:41:04 -0500121 if (!output_packet_len || memcmp(nc_ether, net_null_ethaddr, 6)) {
wdenkb8fb6192004-08-02 21:11:11 +0000122 /* going to check for input packet */
Joe Hershbergerf50357b2012-05-23 07:59:15 +0000123 net_set_udp_handler(nc_handler);
Joe Hershbergerc80b41b02015-04-08 01:41:21 -0500124 net_set_timeout_handler(net_timeout, nc_timeout_handler);
wdenkb8fb6192004-08-02 21:11:11 +0000125 } else {
126 /* send arp request */
wdenka0ebde52004-09-08 22:03:11 +0000127 uchar *pkt;
Joe Hershbergerf50357b2012-05-23 07:59:15 +0000128 net_set_arp_handler(nc_wait_arp_handler);
Joe Hershbergera8ca4f62015-04-08 01:41:05 -0500129 pkt = (uchar *)net_tx_packet + net_eth_hdr_size() +
130 IP_UDP_HDR_SIZE;
Joe Hershberger107b3d02012-05-15 08:59:13 +0000131 memcpy(pkt, output_packet, output_packet_len);
Joe Hershbergera8ca4f62015-04-08 01:41:05 -0500132 net_send_udp_packet(nc_ether, nc_ip, nc_out_port, nc_in_port,
133 output_packet_len);
wdenkb8fb6192004-08-02 21:11:11 +0000134 }
135}
136
Joe Hershberger5874dec2015-04-08 01:41:01 -0500137int nc_input_packet(uchar *pkt, struct in_addr src_ip, unsigned dest_port,
Joe Hershberger58cd2182012-09-18 10:01:32 +0000138 unsigned src_port, unsigned len)
wdenkb8fb6192004-08-02 21:11:11 +0000139{
wdenka0ebde52004-09-08 22:03:11 +0000140 int end, chunk;
141
Joe Hershberger58cd2182012-09-18 10:01:32 +0000142 if (dest_port != nc_in_port || !len)
Joe Hershberger107b3d02012-05-15 08:59:13 +0000143 return 0; /* not for us */
wdenkb8fb6192004-08-02 21:11:11 +0000144
Joe Hershberger5874dec2015-04-08 01:41:01 -0500145 if (src_ip.s_addr != nc_ip.s_addr && !is_broadcast(nc_ip))
Joe Hershberger58cd2182012-09-18 10:01:32 +0000146 return 0; /* not from our client */
147
Joe Hershberger05a377b2012-05-23 08:01:04 +0000148 debug_cond(DEBUG_DEV_PKT, "input: \"%*.*s\"\n", len, len, pkt);
149
Joe Hershberger107b3d02012-05-15 08:59:13 +0000150 if (input_size == sizeof(input_buffer))
151 return 1; /* no space */
152 if (len > sizeof(input_buffer) - input_size)
153 len = sizeof(input_buffer) - input_size;
wdenka0ebde52004-09-08 22:03:11 +0000154
155 end = input_offset + input_size;
Joe Hershberger83c48c52017-08-30 17:32:31 -0500156 if (end >= sizeof(input_buffer))
Joe Hershberger107b3d02012-05-15 08:59:13 +0000157 end -= sizeof(input_buffer);
wdenka0ebde52004-09-08 22:03:11 +0000158
159 chunk = len;
Joe Hershberger83c48c52017-08-30 17:32:31 -0500160 /* Check if packet will wrap in input_buffer */
161 if (end + len >= sizeof(input_buffer)) {
Joe Hershberger107b3d02012-05-15 08:59:13 +0000162 chunk = sizeof(input_buffer) - end;
Joe Hershberger83c48c52017-08-30 17:32:31 -0500163 /* Copy the second part of the pkt to start of input_buffer */
wdenka0ebde52004-09-08 22:03:11 +0000164 memcpy(input_buffer, pkt + chunk, len - chunk);
165 }
Joe Hershberger83c48c52017-08-30 17:32:31 -0500166 /* Copy first (or only) part of pkt after end of current valid input*/
Joe Hershberger107b3d02012-05-15 08:59:13 +0000167 memcpy(input_buffer + end, pkt, chunk);
wdenka0ebde52004-09-08 22:03:11 +0000168
169 input_size += len;
170
wdenkb8fb6192004-08-02 21:11:11 +0000171 return 1;
172}
173
Joe Hershberger107b3d02012-05-15 08:59:13 +0000174static void nc_send_packet(const char *buf, int len)
wdenkb8fb6192004-08-02 21:11:11 +0000175{
Bernhard Nortmann752abb72015-09-14 15:29:44 +0200176 struct udevice *eth;
wdenkb8fb6192004-08-02 21:11:11 +0000177 int inited = 0;
178 uchar *pkt;
wdenka0ebde52004-09-08 22:03:11 +0000179 uchar *ether;
Joe Hershberger5874dec2015-04-08 01:41:01 -0500180 struct in_addr ip;
wdenkb8fb6192004-08-02 21:11:11 +0000181
Joe Hershberger05a377b2012-05-23 08:01:04 +0000182 debug_cond(DEBUG_DEV_PKT, "output: \"%*.*s\"\n", len, len, buf);
183
Joe Hershberger107b3d02012-05-15 08:59:13 +0000184 eth = eth_get_dev();
185 if (eth == NULL)
wdenkb8fb6192004-08-02 21:11:11 +0000186 return;
187
Joe Hershberger8ecdbed2015-04-08 01:41:04 -0500188 if (!memcmp(nc_ether, net_null_ethaddr, 6)) {
Bernhard Nortmann752abb72015-09-14 15:29:44 +0200189 if (eth_is_active(eth))
wdenka0ebde52004-09-08 22:03:11 +0000190 return; /* inside net loop */
191 output_packet = buf;
192 output_packet_len = len;
Suriyan Ramasami7f37f222013-10-16 09:54:24 -0700193 input_recursion = 1;
Joe Hershbergerc80b41b02015-04-08 01:41:21 -0500194 net_loop(NETCONS); /* wait for arp reply and send packet */
Suriyan Ramasami7f37f222013-10-16 09:54:24 -0700195 input_recursion = 0;
wdenka0ebde52004-09-08 22:03:11 +0000196 output_packet_len = 0;
wdenkb8fb6192004-08-02 21:11:11 +0000197 return;
198 }
199
Bernhard Nortmann752abb72015-09-14 15:29:44 +0200200 if (!eth_is_active(eth)) {
Joe Hershberger9f374062012-08-03 10:59:08 +0000201 if (eth_is_on_demand_init()) {
Joe Hershberger3dbe17e2015-03-22 17:09:06 -0500202 if (eth_init() < 0)
Joe Hershberger9f374062012-08-03 10:59:08 +0000203 return;
204 eth_set_last_protocol(NETCONS);
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500205 } else {
Joe Hershberger3dbe17e2015-03-22 17:09:06 -0500206 eth_init_state_only();
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500207 }
Joe Hershberger9f374062012-08-03 10:59:08 +0000208
wdenkb8fb6192004-08-02 21:11:11 +0000209 inited = 1;
210 }
Joe Hershbergera8ca4f62015-04-08 01:41:05 -0500211 pkt = (uchar *)net_tx_packet + net_eth_hdr_size() + IP_UDP_HDR_SIZE;
Joe Hershberger107b3d02012-05-15 08:59:13 +0000212 memcpy(pkt, buf, len);
wdenka0ebde52004-09-08 22:03:11 +0000213 ether = nc_ether;
214 ip = nc_ip;
Joe Hershbergera8ca4f62015-04-08 01:41:05 -0500215 net_send_udp_packet(ether, ip, nc_out_port, nc_in_port, len);
wdenkb8fb6192004-08-02 21:11:11 +0000216
Joe Hershberger9f374062012-08-03 10:59:08 +0000217 if (inited) {
218 if (eth_is_on_demand_init())
219 eth_halt();
220 else
221 eth_halt_state_only();
222 }
wdenkb8fb6192004-08-02 21:11:11 +0000223}
224
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500225static int nc_stdio_start(struct stdio_dev *dev)
wdenkb8fb6192004-08-02 21:11:11 +0000226{
Joe Hershberger66257802012-09-18 10:01:31 +0000227 int retval;
wdenka0ebde52004-09-08 22:03:11 +0000228
Joe Hershbergerd0f53962012-07-31 06:06:41 +0000229 nc_out_port = 6666; /* default port */
230 nc_in_port = nc_out_port;
wdenkb8fb6192004-08-02 21:11:11 +0000231
Joe Hershberger66257802012-09-18 10:01:31 +0000232 retval = refresh_settings_from_env();
233 if (retval != 0)
234 return retval;
wdenka0ebde52004-09-08 22:03:11 +0000235
Joe Hershberger6a9ed162012-05-23 07:59:23 +0000236 /*
237 * Initialize the static IP settings and buffer pointers
Joe Hershbergerc80b41b02015-04-08 01:41:21 -0500238 * incase we call net_send_udp_packet before net_loop
Joe Hershberger6a9ed162012-05-23 07:59:23 +0000239 */
240 net_init();
241
wdenka0ebde52004-09-08 22:03:11 +0000242 return 0;
wdenkb8fb6192004-08-02 21:11:11 +0000243}
244
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500245static void nc_stdio_putc(struct stdio_dev *dev, char c)
wdenkb8fb6192004-08-02 21:11:11 +0000246{
247 if (output_recursion)
248 return;
249 output_recursion = 1;
250
Joe Hershberger107b3d02012-05-15 08:59:13 +0000251 nc_send_packet(&c, 1);
wdenkb8fb6192004-08-02 21:11:11 +0000252
253 output_recursion = 0;
254}
255
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500256static void nc_stdio_puts(struct stdio_dev *dev, const char *s)
wdenkb8fb6192004-08-02 21:11:11 +0000257{
wdenkb21608e2005-04-20 09:28:54 +0000258 int len;
259
wdenkb8fb6192004-08-02 21:11:11 +0000260 if (output_recursion)
261 return;
262 output_recursion = 1;
263
Michael Walle9227aed2011-10-07 12:27:50 +0000264 len = strlen(s);
265 while (len) {
Masahiro Yamadadb204642014-11-07 03:03:31 +0900266 int send_len = min(len, (int)sizeof(input_buffer));
Michael Walle9227aed2011-10-07 12:27:50 +0000267 nc_send_packet(s, send_len);
268 len -= send_len;
269 s += send_len;
270 }
wdenkb8fb6192004-08-02 21:11:11 +0000271
272 output_recursion = 0;
273}
274
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500275static int nc_stdio_getc(struct stdio_dev *dev)
wdenkb8fb6192004-08-02 21:11:11 +0000276{
wdenkb21608e2005-04-20 09:28:54 +0000277 uchar c;
278
wdenkb8fb6192004-08-02 21:11:11 +0000279 input_recursion = 1;
280
281 net_timeout = 0; /* no timeout */
wdenka0ebde52004-09-08 22:03:11 +0000282 while (!input_size)
Joe Hershbergerc80b41b02015-04-08 01:41:21 -0500283 net_loop(NETCONS);
wdenkb8fb6192004-08-02 21:11:11 +0000284
285 input_recursion = 0;
286
wdenkb21608e2005-04-20 09:28:54 +0000287 c = input_buffer[input_offset++];
288
Joe Hershberger107b3d02012-05-15 08:59:13 +0000289 if (input_offset >= sizeof(input_buffer))
290 input_offset -= sizeof(input_buffer);
wdenka0ebde52004-09-08 22:03:11 +0000291 input_size--;
wdenkb8fb6192004-08-02 21:11:11 +0000292
wdenka0ebde52004-09-08 22:03:11 +0000293 return c;
wdenkb8fb6192004-08-02 21:11:11 +0000294}
295
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500296static int nc_stdio_tstc(struct stdio_dev *dev)
wdenkb8fb6192004-08-02 21:11:11 +0000297{
Bernhard Nortmann752abb72015-09-14 15:29:44 +0200298 struct udevice *eth;
wdenkb8fb6192004-08-02 21:11:11 +0000299
300 if (input_recursion)
301 return 0;
302
wdenka0ebde52004-09-08 22:03:11 +0000303 if (input_size)
wdenkb8fb6192004-08-02 21:11:11 +0000304 return 1;
305
Joe Hershberger107b3d02012-05-15 08:59:13 +0000306 eth = eth_get_dev();
Bernhard Nortmann752abb72015-09-14 15:29:44 +0200307 if (eth_is_active(eth))
wdenkb8fb6192004-08-02 21:11:11 +0000308 return 0; /* inside net loop */
309
310 input_recursion = 1;
311
312 net_timeout = 1;
Joe Hershbergerc80b41b02015-04-08 01:41:21 -0500313 net_loop(NETCONS); /* kind of poll */
wdenkb8fb6192004-08-02 21:11:11 +0000314
315 input_recursion = 0;
316
wdenka0ebde52004-09-08 22:03:11 +0000317 return input_size != 0;
wdenkb8fb6192004-08-02 21:11:11 +0000318}
319
Joe Hershberger107b3d02012-05-15 08:59:13 +0000320int drv_nc_init(void)
wdenkb8fb6192004-08-02 21:11:11 +0000321{
Jean-Christophe PLAGNIOL-VILLARD2a7a0312009-05-16 12:14:54 +0200322 struct stdio_dev dev;
wdenkb8fb6192004-08-02 21:11:11 +0000323 int rc;
324
Joe Hershberger107b3d02012-05-15 08:59:13 +0000325 memset(&dev, 0, sizeof(dev));
wdenkb8fb6192004-08-02 21:11:11 +0000326
Joe Hershberger107b3d02012-05-15 08:59:13 +0000327 strcpy(dev.name, "nc");
Bin Meng6abe4b62015-11-03 23:23:37 -0800328 dev.flags = DEV_FLAGS_OUTPUT | DEV_FLAGS_INPUT;
Joe Hershbergerd02aa6b2015-04-08 01:41:16 -0500329 dev.start = nc_stdio_start;
330 dev.putc = nc_stdio_putc;
331 dev.puts = nc_stdio_puts;
332 dev.getc = nc_stdio_getc;
333 dev.tstc = nc_stdio_tstc;
wdenkb8fb6192004-08-02 21:11:11 +0000334
Joe Hershberger107b3d02012-05-15 08:59:13 +0000335 rc = stdio_register(&dev);
wdenkb8fb6192004-08-02 21:11:11 +0000336
337 return (rc == 0) ? 1 : rc;
338}