From af6ee422a8dc5280a3aa7916c1742ecfdc9a57d7 Mon Sep 17 00:00:00 2001
From: sola.lu <sola.lu@greentest.com.cn>
Date: 周三, 23 4月 2025 18:01:08 +0800
Subject: [PATCH] 1. 添加一些注释
---
examples/test-LwIP-netconn/scpi_server.c | 158 +++++++++++++++++++++++++++++++++++-----------------
1 files changed, 105 insertions(+), 53 deletions(-)
diff --git a/examples/test-LwIP-netconn/scpi_server.c b/examples/test-LwIP-netconn/scpi_server.c
index 1b300de..6147235 100644
--- a/examples/test-LwIP-netconn/scpi_server.c
+++ b/examples/test-LwIP-netconn/scpi_server.c
@@ -1,28 +1,29 @@
/*-
- * Copyright (c) 2012-2013 Jan Breuer,
+ * BSD 2-Clause License
*
- * All Rights Reserved
+ * Copyright (c) 2012-2018, Jan Breuer
+ * All rights reserved.
*
* 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.
+ * modification, are permitted provided that the following conditions are met:
*
- * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``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 AUTHORS OR CONTRIBUTORS 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.
+ * * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * * 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS 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.
*/
/**
@@ -47,10 +48,6 @@
#include "task.h"
#include "lwip/tcp.h"
#include "lwip/inet.h"
-
-
-#define DEVICE_PORT 5025
-#define CONTROL_PORT 5026
#define SCPI_THREAD_PRIO (tskIDLE_PRIORITY + 2)
@@ -93,7 +90,7 @@
if (context->user_context != NULL) {
user_data_t * u = (user_data_t *) (context->user_context);
if (u->io) {
- return (netconn_write(u->io, data, len, NETCONN_NOCOPY) == ERR_OK) ? len : 0;
+ return (netconn_write(u->io, data, len, NETCONN_COPY) == ERR_OK) ? len : 0;
}
}
return 0;
@@ -111,16 +108,13 @@
}
int SCPI_Error(scpi_t * context, int_fast16_t err) {
- (void) context;
- /* BEEP */
- iprintf("**ERROR: %ld, \"%s\"\r\n", (int32_t) err, SCPI_ErrorTranslate(err));
+ (void) context;
if (err != 0) {
/* New error */
- /* Beep */
- /* Error LED ON */
+ SCPI_Event_ErrorIndicatorOn(context, err);
} else {
/* No more errors in the queue */
- /* Error LED OFF */
+ SCPI_Event_ErrorIndicatorOff(context, err);
}
return 0;
}
@@ -138,20 +132,20 @@
user_data_t * u = (user_data_t *) (context->user_context);
if (u->control_io) {
snprintf(b, sizeof (b), "SRQ%d\r\n", val);
- return netconn_write(u->control_io, b, strlen(b), NETCONN_NOCOPY) == ERR_OK ? SCPI_RES_OK : SCPI_RES_ERR;
+ return netconn_write(u->control_io, b, strlen(b), NETCONN_COPY) == ERR_OK ? SCPI_RES_OK : SCPI_RES_ERR;
}
}
return SCPI_RES_OK;
}
-scpi_result_t SCPI_Reset(scpi_t * context) {
+scpi_result_t __attribute__((weak)) SCPI_Reset(scpi_t * context) {
(void) context;
iprintf("**Reset\r\n");
return SCPI_RES_OK;
}
scpi_result_t SCPI_SystemCommTcpipControlQ(scpi_t * context) {
- SCPI_ResultInt(context, CONTROL_PORT);
+ SCPI_ResultInt(context, SCPI_CONTROL_PORT);
return SCPI_RES_OK;
}
@@ -164,6 +158,7 @@
}
void SCPI_RequestControl(void) {
+ BaseType_t xReturned;
queue_event_t msg;
msg.cmd = SCPI_MSG_SET_ESE_REQ;
@@ -173,18 +168,24 @@
}
*/
- xQueueSend(user_data.evtQueue, &msg, 1000);
+ xReturned = xQueueSend(user_data.evtQueue, &msg, 1000);
+ /* @fixme: replace by real error handling code */
+ LWIP_ASSERT("SCPI_RequestControl failed", xReturned == pdPASS);
}
void SCPI_AddError(int16_t err) {
+ BaseType_t xReturned;
queue_event_t msg;
msg.cmd = SCPI_MSG_SET_ERROR;
msg.param2 = err;
- xQueueSend(user_data.evtQueue, &msg, 1000);
+ xReturned = xQueueSend(user_data.evtQueue, &msg, 1000);
+ /* @fixme: replace by real error handling code */
+ LWIP_ASSERT("SCPI_AddError failed", xReturned == pdPASS);
}
void scpi_netconn_callback(struct netconn * conn, enum netconn_evt evt, u16_t len) {
+ BaseType_t xReturned;
queue_event_t msg;
(void) len;
@@ -200,7 +201,9 @@
} else if (conn == user_data.control_io_listen) {
msg.cmd = SCPI_MSG_CONTROL_IO_LISTEN;
}
- xQueueSend(user_data.evtQueue, &msg, 1000);
+ xReturned = xQueueSend(user_data.evtQueue, &msg, 1000);
+ /* @fixme: replace by real error handling code */
+ LWIP_ASSERT("scpi_netconn_callback failed", xReturned == pdPASS);
}
}
@@ -232,7 +235,7 @@
}
}
-static int processIoListen(user_data_t * user_data) {
+static int processIoListen(scpi_t * context, user_data_t * user_data) {
struct netconn *newconn;
if (netconn_accept(user_data->io_listen, &newconn) == ERR_OK) {
@@ -242,7 +245,11 @@
netconn_delete(newconn);
} else {
/* connection established */
- iprintf("***Connection established %s\r\n", inet_ntoa(newconn->pcb.ip->remote_ip));
+ SCPI_Event_DeviceConnected(context, newconn);
+ ip_set_option(newconn->pcb.tcp, SOF_KEEPALIVE);
+ newconn->pcb.tcp->keep_idle = SCPI_KEEP_IDLE; // Override TCP_KEEPIDLE_DEFAULT for this connection.
+ newconn->pcb.tcp->keep_intvl = SCPI_KEEP_INTVL; // Override TCP_KEEPINTVL_DEFAULT for this connection.
+ newconn->pcb.tcp->keep_cnt = SCPI_KEEP_CNT; // Override TCP_KEEPCNT_DEFAULT for this connection.
user_data->io = newconn;
}
}
@@ -250,7 +257,7 @@
return 0;
}
-static int processSrqIoListen(user_data_t * user_data) {
+static int processSrqIoListen(scpi_t * context, user_data_t * user_data) {
struct netconn *newconn;
if (netconn_accept(user_data->control_io_listen, &newconn) == ERR_OK) {
@@ -259,7 +266,11 @@
netconn_delete(newconn);
} else {
/* control connection established */
- iprintf("***Control Connection established %s\r\n", inet_ntoa(newconn->pcb.ip->remote_ip));
+ SCPI_Event_ControlConnected(context, newconn);
+ ip_set_option(newconn->pcb.tcp, SOF_KEEPALIVE);
+ newconn->pcb.tcp->keep_idle = SCPI_KEEP_IDLE; // Override TCP_KEEPIDLE_DEFAULT for this connection.
+ newconn->pcb.tcp->keep_intvl = SCPI_KEEP_INTVL; // Override TCP_KEEPINTVL_DEFAULT for this connection.
+ newconn->pcb.tcp->keep_cnt = SCPI_KEEP_CNT; // Override TCP_KEEPCNT_DEFAULT for this connection.
user_data->control_io = newconn;
}
}
@@ -267,20 +278,20 @@
return 0;
}
-static void closeIo(user_data_t * user_data) {
+static void closeIo(scpi_t * context, user_data_t * user_data) {
/* connection closed */
+ SCPI_Event_DeviceDisconnected(context, user_data->io);
netconn_close(user_data->io);
netconn_delete(user_data->io);
user_data->io = NULL;
- iprintf("***Connection closed\r\n");
}
-static void closeSrqIo(user_data_t * user_data) {
+static void closeSrqIo(scpi_t * context, user_data_t * user_data) {
/* control connection closed */
+ SCPI_Event_ControlDisconnected(context, user_data->io);
netconn_close(user_data->control_io);
netconn_delete(user_data->control_io);
user_data->control_io = NULL;
- iprintf("***Control Connection closed\r\n");
}
static int processIo(user_data_t * user_data) {
@@ -356,6 +367,7 @@
(void) arg;
user_data.evtQueue = xQueueCreate(10, sizeof (queue_event_t));
+ LWIP_ASSERT("user_data.evtQueue != NULL", user_data.evtQueue != NULL);
/* user_context will be pointer to socket */
SCPI_Init(&scpi_context,
@@ -368,8 +380,11 @@
scpi_context.user_context = &user_data;
- user_data.io_listen = createServer(DEVICE_PORT);
- user_data.control_io_listen = createServer(CONTROL_PORT);
+ user_data.io_listen = createServer(SCPI_DEVICE_PORT);
+ LWIP_ASSERT("user_data.io_listen != NULL", user_data.io_listen != NULL);
+
+ user_data.control_io_listen = createServer(SCPI_CONTROL_PORT);
+ LWIP_ASSERT("user_data.control_io_listen != NULL", user_data.control_io_listen != NULL);
while (1) {
waitServer(&user_data, &evt);
@@ -379,19 +394,19 @@
}
if ((user_data.io_listen != NULL) && (evt.cmd == SCPI_MSG_IO_LISTEN)) {
- processIoListen(&user_data);
+ processIoListen(&scpi_context, &user_data);
}
if ((user_data.control_io_listen != NULL) && (evt.cmd == SCPI_MSG_CONTROL_IO_LISTEN)) {
- processSrqIoListen(&user_data);
+ processSrqIoListen(&scpi_context, &user_data);
}
if ((user_data.io != NULL) && (evt.cmd == SCPI_MSG_IO)) {
- processIo(&user_data);
+ processIo(&scpi_context, &user_data);
}
if ((user_data.control_io != NULL) && (evt.cmd == SCPI_MSG_CONTROL_IO)) {
- processSrqIo(&user_data);
+ processSrqIo(&scpi_context, &user_data);
}
if (evt.cmd == SCPI_MSG_SET_ESE_REQ) {
@@ -408,5 +423,42 @@
}
void scpi_server_init(void) {
- sys_thread_new("SCPI", scpi_server_thread, NULL, 2 * DEFAULT_THREAD_STACKSIZE, SCPI_THREAD_PRIO);
-}
\ No newline at end of file
+ TaskHandle_t xHandle = NULL;
+ BaseType_t xReturned;
+ xReturned = xTaskCreate(scpi_server_thread, "SCPI", DEFAULT_THREAD_STACKSIZE, NULL, SCPI_THREAD_PRIO, &xHandle);
+ LWIP_ASSERT("scpi_server_init failed", xReturned == pdPASS);
+}
+
+/* Called by processIoListen() for additional reporting. Override on demand. */
+void __attribute__((weak)) SCPI_Event_DeviceConnected(scpi_t * context, struct netconn * conn) {
+ iprintf("***Connection established %s\r\n", inet_ntoa(newconn->pcb.ip->remote_ip));
+ /* Remote or Eth LED ON */
+}
+
+/* Called by closeIO() for additional reporting. Override on demand. */
+void __attribute__((weak)) SCPI_Event_DeviceDisconnected(scpi_t * context, struct netconn * conn) {
+ iprintf("***Connection closed\r\n");
+ /* Remote or Eth LED OFF */
+}
+
+/* Called by processIoListen() for additional reporting. Override on demand. */
+void __attribute__((weak)) SCPI_Event_ControlConnected(scpi_t * context, struct netconn * conn) {
+ iprintf("***Control Connection established %s\r\n", inet_ntoa(newconn->pcb.ip->remote_ip));
+}
+
+/* Called by closeIO() for additional reporting. Override on demand. */
+void __attribute__((weak)) SCPI_Event_ControlDisconnected(scpi_t * context, struct netconn * conn) {
+ iprintf("***Control Connection closed\r\n");
+}
+
+/* Called by SCPI_Error() for reporting. Override on demand. */
+void __attribute__((weak)) SCPI_Event_ErrorIndicatorOn(scpi_t * context, int_fast16_t err) {
+ iprintf("**ERROR: %ld, \"%s\"\r\n", (int32_t) err, SCPI_ErrorTranslate(err));
+ /* New error : BEEP, Error LED ON */
+}
+
+/* Called by SCPI_Error() for reporting. Override on demand. */
+void __attribute__((weak)) SCPI_Event_ErrorIndicatorOff(scpi_t * context, int_fast16_t err) {
+ iprintf("**ERROR: %ld, \"%s\"\r\n", (int32_t) err, SCPI_ErrorTranslate(err));
+ /* No more errors in the queue : Error LED OFF */
+}
--
Gitblit v1.9.1