common: Move env_get_ip() to net.h
authorSimon Glass <sjg@chromium.org>
Thu, 14 Nov 2019 19:57:21 +0000 (12:57 -0700)
committerTom Rini <trini@konsulko.com>
Mon, 2 Dec 2019 23:23:09 +0000 (18:23 -0500)
This function relates to networking, so move it out of the common.h
header file.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Tom Rini <trini@konsulko.com>
Acked-by: Joe Hershberger <joe.hershberger@ni.com>
include/common.h
include/net.h

index f993e4bef333ce45f7137bd13e319f7677d67781..4fda40cc1d6b2413fd95c8f7fcfe84973c30fd8a 100644 (file)
@@ -319,10 +319,6 @@ int        serial_printf (const char *fmt, ...)
 
 /* lib/net_utils.c */
 #include <net.h>
-static inline struct in_addr env_get_ip(char *var)
-{
-       return string_to_ip(env_get(var));
-}
 
 #include <bootstage.h>
 
index d8d187d8af9b98fd2d9532c06ddde17d3fdc4690..11eca1bc6c33d3eedf1a80b614af542e08e6fcf2 100644 (file)
@@ -829,7 +829,13 @@ static inline void net_random_ethaddr(uchar *addr)
 /* Convert an IP address to a string */
 void ip_to_string(struct in_addr x, char *s);
 
-/* Convert a string to ip address */
+/**
+ * string_to_ip() - Convert a string to ip address
+ *
+ * @s: String to conver, in the format format a.b.c.d, where each value is a
+ *     decimal number from 0 to 255
+ * @return IP address, or 0 if invalid
+ */
 struct in_addr string_to_ip(const char *s);
 
 /* Convert a VLAN id to a string */
@@ -887,4 +893,17 @@ int update_tftp(ulong addr, char *interface, char *devstring);
  */
 void eth_parse_enetaddr(const char *addr, uint8_t *enetaddr);
 
+/**
+ * env_get_ip() - Convert an environment value to to an ip address
+ *
+ * @var: Environment variable to convert. The value of this variable must be
+ *     in the format format a.b.c.d, where each value is a decimal number from
+ *     0 to 255
+ * @return IP address, or 0 if invalid
+ */
+static inline struct in_addr env_get_ip(char *var)
+{
+       return string_to_ip(env_get(var));
+}
+
 #endif /* __NET_H__ */