summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAmerigo Wang <amwang@redhat.com>2012-10-11 21:06:17 +0000
committerDavid S. Miller <davem@davemloft.net>2012-10-12 13:56:52 -0400
commit93ac0ef016a1b223d23fbb5e0397cab75a8f7d34 (patch)
treec5e4199d447064d4da2b4e786b94469332444eaa
parent28194fcdc150e4d5b418d01db3c29058f60ef32c (diff)
downloadlinux-93ac0ef016a1b223d23fbb5e0397cab75a8f7d34.tar.bz2
net: add doc for in4_pton()
It is not easy to use in4_pton() correctly without reading its definition, so add some doc for it. Cc: David S. Miller <davem@davemloft.net> Signed-off-by: Cong Wang <amwang@redhat.com> Signed-off-by: David S. Miller <davem@davemloft.net>
-rw-r--r--net/core/utils.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/net/core/utils.c b/net/core/utils.c
index 30f3879faecc..e3487e461939 100644
--- a/net/core/utils.c
+++ b/net/core/utils.c
@@ -107,6 +107,18 @@ static inline int xdigit2bin(char c, int delim)
return IN6PTON_UNKNOWN;
}
+/**
+ * in4_pton - convert an IPv4 address from literal to binary representation
+ * @src: the start of the IPv4 address string
+ * @srclen: the length of the string, -1 means strlen(src)
+ * @dst: the binary (u8[4] array) representation of the IPv4 address
+ * @delim: the delimiter of the IPv4 address in @src, -1 means no delimiter
+ * @end: A pointer to the end of the parsed string will be placed here
+ *
+ * Return one on success, return zero when any error occurs
+ * and @end will point to the end of the parsed string.
+ *
+ */
int in4_pton(const char *src, int srclen,
u8 *dst,
int delim, const char **end)