--- /dev/null
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <string.h>
+#include "esp_ping.h"
+
+#include "lwip/ip_addr.h"
+
+typedef struct _ping_option {
+ ip4_addr_t ping_target;
+ uint32_t ping_count;
+ uint32_t ping_rcv_timeout;
+ uint32_t ping_delay;
+ uint16_t ping_id;
+ esp_ping_found_fn ping_res_fn;
+ esp_ping_found ping_res;
+ void *ping_reserve;
+} ping_option;
+
+static ping_option ping_option_info[1];
+
+esp_err_t esp_ping_set_target(ping_target_id_t opt_id, void *opt_val, uint32_t opt_len)
+{
+ esp_err_t ret = ESP_OK;
+
+ if (opt_val == NULL) {
+ return ESP_ERR_PING_INVALID_PARAMS;
+ }
+
+ switch (opt_id) {
+ case PING_TARGET_IP_ADDRESS:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ ping_option_info->ping_target.addr = *(uint32_t *)opt_val;
+ break;
+ case PING_TARGET_IP_ADDRESS_COUNT:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ ping_option_info->ping_count = *(uint32_t *)opt_val;
+ break;
+ case PING_TARGET_RCV_TIMEO:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ ping_option_info->ping_rcv_timeout = (*(uint32_t *)opt_val) * 1000;
+ break;
+ case PING_TARGET_DELAY_TIME:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ ping_option_info->ping_delay = (*(uint32_t *)opt_val) * 1000;
+ break;
+ case PING_TARGET_ID:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint16_t);
+ ping_option_info->ping_id = *(uint16_t *)opt_val;
+ break;
+ case PING_TARGET_RES_FN:
+ ping_option_info->ping_res_fn = opt_val;
+ break;
+ default:
+ ret = ESP_ERR_PING_INVALID_PARAMS;
+ break;
+ }
+
+ return ret;
+}
+
+esp_err_t esp_ping_get_target(ping_target_id_t opt_id, void *opt_val, uint32_t opt_len)
+{
+ esp_err_t ret = ESP_OK;
+
+ if (opt_val == NULL) {
+ return ESP_ERR_PING_INVALID_PARAMS;
+ }
+
+ switch (opt_id) {
+ case PING_TARGET_IP_ADDRESS:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ *(uint32_t *)opt_val = ping_option_info->ping_target.addr;
+ break;
+ case PING_TARGET_IP_ADDRESS_COUNT:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ *(uint32_t *)opt_val = ping_option_info->ping_count;
+ break;
+ case PING_TARGET_RCV_TIMEO:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ *(uint32_t *)opt_val = ping_option_info->ping_rcv_timeout;
+ break;
+ case PING_TARGET_DELAY_TIME:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint32_t);
+ *(uint32_t *)opt_val = ping_option_info->ping_delay;
+ break;
+ case PING_TARGET_ID:
+ ESP_PING_CHECK_OPTLEN(opt_len, uint16_t);
+ *(uint16_t *)opt_val = ping_option_info->ping_id;
+ break;
+ default:
+ ret = ESP_ERR_PING_INVALID_PARAMS;
+ break;
+ }
+
+ return ret;
+}
+
+esp_err_t esp_ping_result(uint8_t res_val, uint16_t ping_len, uint32_t ping_time)
+{
+ esp_err_t ret = ESP_OK;
+
+ ping_option_info->ping_res.bytes = ping_len;
+ ping_option_info->ping_res.ping_err = res_val;
+ ping_option_info->ping_res.resp_time = ping_time;
+ ping_option_info->ping_res.total_time += ping_time;
+ ping_option_info->ping_res.total_bytes += ping_len;
+
+ if (res_val == 0) {
+ ping_option_info->ping_res.timeout_count ++;
+ }
+
+ if (--ping_option_info->ping_count != 0 && ping_option_info->ping_res_fn) {
+ ping_option_info->ping_res_fn(PING_TARGET_RES_FN, &ping_option_info->ping_res);
+ } else {
+ memset(&ping_option_info->ping_res, 0, sizeof(esp_ping_found));
+ }
+
+ return ret;
+}
--- /dev/null
+// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef ESP_PING_H_
+#define ESP_PING_H_
+
+#include "esp_err.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#define ESP_ERR_PING_BASE 0x5000
+
+#define ESP_ERR_PING_INVALID_PARAMS ESP_ERR_PING_BASE + 0x00
+#define ESP_ERR_PING_NO_MEM ESP_ERR_PING_BASE + 0x01
+
+#define ESP_PING_CHECK_OPTLEN(optlen, opttype) do { if ((optlen) < sizeof(opttype)) { return ESP_ERR_PING_INVALID_PARAMS; }}while(0)
+
+typedef struct _ping_found {
+ uint32_t resp_time;
+ uint32_t timeout_count;
+ uint32_t bytes;
+ uint32_t total_bytes;
+ uint32_t total_time;
+ int8_t ping_err;
+} esp_ping_found;
+
+typedef enum {
+ PING_TARGET_IP_ADDRESS = 50, /**< target IP address */
+ PING_TARGET_IP_ADDRESS_COUNT = 51, /**< target IP address total counter */
+ PING_TARGET_RCV_TIMEO = 52, /**< receive timeout */
+ PING_TARGET_DELAY_TIME = 53, /**< delay time */
+ PING_TARGET_ID = 54, /**< identifier */
+ PING_TARGET_RES_FN = 55
+} ping_target_id_t;
+
+typedef void (* esp_ping_found_fn)(ping_target_id_t found_id, esp_ping_found *found_val);
+
+/**
+ * @brief Set PING function option
+ *
+ * @param[in] opt_id: option index, 50 for IP, 51 for COUNT, 52 for RCV TIMEOUT, 53 for DELAY TIME, 54 for ID
+ * @param[in] opt_val: option parameter
+ * @param[in] opt_len: option length
+ *
+ * @return
+ * - ESP_OK
+ * - ESP_ERR_PING_INVALID_PARAMS
+ */
+esp_err_t esp_ping_set_target(ping_target_id_t opt_id, void *opt_val, uint32_t opt_len);
+
+/**
+ * @brief Get PING function option
+ *
+ * @param[in] opt_id: option index, 50 for IP, 51 for COUNT, 52 for RCV TIMEOUT, 53 for DELAY TIME, 54 for ID
+ * @param[in] opt_val: option parameter
+ * @param[in] opt_len: option length
+ *
+ * @return
+ * - ESP_OK
+ * - ESP_ERR_PING_INVALID_PARAMS
+ */
+esp_err_t esp_ping_get_target(ping_target_id_t opt_id, void *opt_val, uint32_t opt_len);
+
+/**
+ * @brief Get PING function result action
+ *
+ * @param[in] res_val: ping function action, 1 for successful, 0 for fail.
+ * res_len: response bytes
+ * res_time: response time
+ *
+ * @return
+ * - ESP_OK
+ * - ESP_ERR_PING_INVALID_PARAMS
+ */
+esp_err_t esp_ping_result(uint8_t res_val, uint16_t res_len, uint32_t res_time);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ESP_PING_H_ */
--- /dev/null
+/**
+ * @file
+ * Ping sender module
+ *
+ */
+
+/*
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * 3. The name of the author may not be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+ * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+ * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+ * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+ * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+ * OF SUCH DAMAGE.
+ *
+ * This file is part of the lwIP TCP/IP stack.
+ *
+ */
+
+/**
+ * This is an example of a "ping" sender (with raw API and socket API).
+ * It can be used as a start point to maintain opened a network connection, or
+ * like a network "watchdog" for your device.
+ *
+ */
+
+#include "lwip/opt.h"
+
+#if LWIP_IPV4 && LWIP_RAW /* don't build if not configured for use in lwipopts.h */
+
+#include "ping.h"
+
+#include "lwip/mem.h"
+#include "lwip/raw.h"
+#include "lwip/icmp.h"
+#include "lwip/netif.h"
+#include "lwip/sys.h"
+#include "lwip/timers.h"
+#include "lwip/inet_chksum.h"
+
+#if PING_USE_SOCKETS
+#include "lwip/sockets.h"
+#include "lwip/inet.h"
+#endif /* PING_USE_SOCKETS */
+
+#ifdef ESP_LWIP
+#include "esp_ping.h"
+#include "lwip/ip_addr.h"
+#endif
+/**
+ * PING_DEBUG: Enable debugging for PING.
+ */
+#ifndef PING_DEBUG
+#define PING_DEBUG LWIP_DBG_ON
+#endif
+
+/** ping target - should be an "ip4_addr_t" */
+#ifndef PING_TARGET
+#define PING_TARGET (netif_default ? *netif_ip4_gw(netif_default) : (*IP4_ADDR_ANY))
+#endif
+
+/** ping receive timeout - in milliseconds */
+#ifndef PING_RCV_TIMEO
+#define PING_RCV_TIMEO 1000
+#endif
+
+/** ping delay - in milliseconds */
+#ifndef PING_DELAY
+#define PING_DELAY 1000
+#endif
+
+/** ping identifier - must fit on a u16_t */
+#ifndef PING_ID
+#define PING_ID 0xAFAF
+#endif
+
+/** ping additional data size to include in the packet */
+#ifndef PING_DATA_SIZE
+#define PING_DATA_SIZE 32
+#endif
+
+/** ping result action - no default action */
+#ifndef PING_RESULT
+#define PING_RESULT(ping_ok)
+#endif
+
+/* ping variables */
+static u16_t ping_seq_num;
+static u32_t ping_time;
+#if !PING_USE_SOCKETS
+static struct raw_pcb *ping_pcb;
+#endif /* PING_USE_SOCKETS */
+
+/** Prepare a echo ICMP request */
+static void
+ping_prepare_echo( struct icmp_echo_hdr *iecho, u16_t len)
+{
+ size_t i;
+ size_t data_len = len - sizeof(struct icmp_echo_hdr);
+
+ ICMPH_TYPE_SET(iecho, ICMP_ECHO);
+ ICMPH_CODE_SET(iecho, 0);
+ iecho->chksum = 0;
+ iecho->id = PING_ID;
+ iecho->seqno = lwip_htons(++ping_seq_num);
+
+ /* fill the additional data buffer with some data */
+ for(i = 0; i < data_len; i++) {
+ ((char*)iecho)[sizeof(struct icmp_echo_hdr) + i] = (char)i;
+ }
+
+ iecho->chksum = inet_chksum(iecho, len);
+}
+
+#if PING_USE_SOCKETS
+
+/* Ping using the socket ip */
+static err_t
+ping_send(int s, ip_addr_t *addr)
+{
+ int err;
+ struct icmp_echo_hdr *iecho;
+ struct sockaddr_in to;
+ size_t ping_size = sizeof(struct icmp_echo_hdr) + PING_DATA_SIZE;
+ LWIP_ASSERT("ping_size is too big", ping_size <= 0xffff);
+ LWIP_ASSERT("ping: expect IPv4 address", !IP_IS_V6(addr));
+
+ iecho = (struct icmp_echo_hdr *)mem_malloc((mem_size_t)ping_size);
+ if (!iecho) {
+ return ERR_MEM;
+ }
+
+ ping_prepare_echo(iecho, (u16_t)ping_size);
+
+ to.sin_len = sizeof(to);
+ to.sin_family = AF_INET;
+ inet_addr_from_ipaddr(&to.sin_addr, ip_2_ip4(addr));
+
+ err = lwip_sendto(s, iecho, ping_size, 0, (struct sockaddr*)&to, sizeof(to));
+
+ mem_free(iecho);
+
+ return (err ? ERR_OK : ERR_VAL);
+}
+
+static void
+ping_recv(int s)
+{
+ char buf[64];
+ int len;
+ struct sockaddr_in from;
+ struct ip_hdr *iphdr;
+ struct icmp_echo_hdr *iecho;
+ int fromlen = sizeof(from);
+
+ while((len = lwip_recvfrom(s, buf, sizeof(buf), 0, (struct sockaddr*)&from, (socklen_t*)&fromlen)) > 0) {
+ if (len >= (int)(sizeof(struct ip_hdr)+sizeof(struct icmp_echo_hdr))) {
+ if (from.sin_family != AF_INET) {
+ /* Ping is not IPv4 */
+ LWIP_DEBUGF( PING_DEBUG, ("ping: invalid sin_family\n"));
+ } else {
+ ip4_addr_t fromaddr;
+ inet_addr_to_ipaddr(&fromaddr, &from.sin_addr);
+ LWIP_DEBUGF( PING_DEBUG, ("ping: recv "));
+ ip4_addr_debug_print(PING_DEBUG, &fromaddr);
+ LWIP_DEBUGF( PING_DEBUG, (" %"U32_F" ms\n", (sys_now() - ping_time)));
+
+ iphdr = (struct ip_hdr *)buf;
+ iecho = (struct icmp_echo_hdr *)(buf + (IPH_HL(iphdr) * 4));
+ if ((iecho->id == PING_ID) && (iecho->seqno == lwip_htons(ping_seq_num))) {
+ /* do some ping result processing */
+#ifdef ESP_LWIP
+ esp_ping_result((ICMPH_TYPE(iecho) == ICMP_ER), len, (sys_now() - ping_time));
+#else
+ PING_RESULT((ICMPH_TYPE(iecho) == ICMP_ER));
+#endif
+ return;
+ } else {
+ LWIP_DEBUGF( PING_DEBUG, ("ping: drop\n"));
+ }
+ }
+ }
+ fromlen = sizeof(from);
+ }
+
+ if (len == 0) {
+ LWIP_DEBUGF( PING_DEBUG, ("ping: recv - %"U32_F" ms - timeout\n", (sys_now()-ping_time)));
+ }
+
+ /* do some ping result processing */
+#ifdef ESP_LWIP
+ esp_ping_result(0, len, (sys_now()-ping_time));
+#else
+ PING_RESULT(0);
+#endif
+}
+
+static void
+ping_thread(void *arg)
+{
+ int s;
+ int ret;
+ ip_addr_t ping_target;
+#if LWIP_SO_SNDRCVTIMEO_NONSTANDARD
+ int timeout = PING_RCV_TIMEO;
+#else
+ struct timeval timeout;
+ timeout.tv_sec = PING_RCV_TIMEO/1000;
+ timeout.tv_usec = (PING_RCV_TIMEO%1000)*1000;
+#endif
+ LWIP_UNUSED_ARG(arg);
+
+ if ((s = lwip_socket(AF_INET, SOCK_RAW, IP_PROTO_ICMP)) < 0) {
+ return;
+ }
+
+ ret = lwip_setsockopt(s, SOL_SOCKET, SO_RCVTIMEO, &timeout, sizeof(timeout));
+ LWIP_ASSERT("setting receive timeout failed", ret == 0);
+ LWIP_UNUSED_ARG(ret);
+
+ while (1) {
+#ifdef ESP_LWIP
+ ip4_addr_t ipaddr;
+ esp_ping_get_target(PING_TARGET_IP_ADDRESS, &ipaddr.addr, sizeof(uint32_t));
+ ip_addr_copy_from_ip4(ping_target, ipaddr);
+#else
+ ip_addr_copy_from_ip4(ping_target, PING_TARGET);
+#endif
+
+ if (ping_send(s, &ping_target) == ERR_OK) {
+ LWIP_DEBUGF( PING_DEBUG, ("ping: send "));
+ ip_addr_debug_print(PING_DEBUG, &ping_target);
+ LWIP_DEBUGF( PING_DEBUG, ("\n"));
+
+ ping_time = sys_now();
+ ping_recv(s);
+ } else {
+ LWIP_DEBUGF( PING_DEBUG, ("ping: send "));
+ ip_addr_debug_print(PING_DEBUG, &ping_target);
+ LWIP_DEBUGF( PING_DEBUG, (" - error\n"));
+ }
+ sys_msleep(PING_DELAY);
+ }
+}
+
+#else /* PING_USE_SOCKETS */
+
+/* Ping using the raw ip */
+static u8_t
+ping_recv(void *arg, struct raw_pcb *pcb, struct pbuf *p, const ip_addr_t *addr)
+{
+ struct icmp_echo_hdr *iecho;
+ LWIP_UNUSED_ARG(arg);
+ LWIP_UNUSED_ARG(pcb);
+ LWIP_UNUSED_ARG(addr);
+ LWIP_ASSERT("p != NULL", p != NULL);
+
+ if ((p->tot_len >= (PBUF_IP_HLEN + sizeof(struct icmp_echo_hdr))) &&
+ pbuf_header(p, -PBUF_IP_HLEN) == 0) {
+ iecho = (struct icmp_echo_hdr *)p->payload;
+
+ if ((iecho->id == PING_ID) && (iecho->seqno == lwip_htons(ping_seq_num))) {
+ LWIP_DEBUGF( PING_DEBUG, ("ping: recv "));
+ ip_addr_debug_print(PING_DEBUG, addr);
+ LWIP_DEBUGF( PING_DEBUG, (" %"U32_F" ms\n", (sys_now()-ping_time)));
+
+ /* do some ping result processing */
+ PING_RESULT(1);
+ pbuf_free(p);
+ return 1; /* eat the packet */
+ }
+ /* not eaten, restore original packet */
+ pbuf_header(p, PBUF_IP_HLEN);
+ }
+
+ return 0; /* don't eat the packet */
+}
+
+static void
+ping_send(struct raw_pcb *raw, ip_addr_t *addr)
+{
+ struct pbuf *p;
+ struct icmp_echo_hdr *iecho;
+ size_t ping_size = sizeof(struct icmp_echo_hdr) + PING_DATA_SIZE;
+
+ LWIP_DEBUGF( PING_DEBUG, ("ping: send "));
+ ip_addr_debug_print(PING_DEBUG, addr);
+ LWIP_DEBUGF( PING_DEBUG, ("\n"));
+ LWIP_ASSERT("ping_size <= 0xffff", ping_size <= 0xffff);
+
+ p = pbuf_alloc(PBUF_IP, (u16_t)ping_size, PBUF_RAM);
+ if (!p) {
+ return;
+ }
+ if ((p->len == p->tot_len) && (p->next == NULL)) {
+ iecho = (struct icmp_echo_hdr *)p->payload;
+
+ ping_prepare_echo(iecho, (u16_t)ping_size);
+
+ raw_sendto(raw, p, addr);
+ ping_time = sys_now();
+ }
+ pbuf_free(p);
+}
+
+static void
+ping_timeout(void *arg)
+{
+ struct raw_pcb *pcb = (struct raw_pcb*)arg;
+ ip_addr_t ping_target;
+
+ LWIP_ASSERT("ping_timeout: no pcb given!", pcb != NULL);
+
+ ip_addr_copy_from_ip4(ping_target, PING_TARGET);
+ ping_send(pcb, &ping_target);
+
+ sys_timeout(PING_DELAY, ping_timeout, pcb);
+}
+
+static void
+ping_raw_init(void)
+{
+ ping_pcb = raw_new(IP_PROTO_ICMP);
+ LWIP_ASSERT("ping_pcb != NULL", ping_pcb != NULL);
+
+ raw_recv(ping_pcb, ping_recv, NULL);
+ raw_bind(ping_pcb, IP_ADDR_ANY);
+ sys_timeout(PING_DELAY, ping_timeout, ping_pcb);
+}
+
+void
+ping_send_now(void)
+{
+ ip_addr_t ping_target;
+ LWIP_ASSERT("ping_pcb != NULL", ping_pcb != NULL);
+ ip_addr_copy_from_ip4(ping_target, PING_TARGET);
+ ping_send(ping_pcb, &ping_target);
+}
+
+#endif /* PING_USE_SOCKETS */
+
+void
+ping_init(void)
+{
+#if PING_USE_SOCKETS
+ sys_thread_new("ping_thread", ping_thread, NULL, DEFAULT_THREAD_STACKSIZE, DEFAULT_THREAD_PRIO);
+#else /* PING_USE_SOCKETS */
+ ping_raw_init();
+#endif /* PING_USE_SOCKETS */
+}
+
+#endif /* LWIP_IPV4 && LWIP_RAW */
projects / esp-idf / commitdiff