Skip to content

Commit

Permalink
Merge branch 'master' into keep-alive
Browse files Browse the repository at this point in the history
  • Loading branch information
@j123b567
j123b567 authored Nov 9, 2021
2 parents 984174f + 77670c4 commit 42841c3
Show file tree
Hide file tree
Showing 3 changed files with 79 additions and 28 deletions.
6 changes: 6 additions & 0 deletions examples/common/scpi-def.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@

#ifndef __SCPI_DEF_H_
#define __SCPI_DEF_H_
#ifdef __cplusplus
extern "C" {
#endif

#include "scpi/scpi.h"

Expand All @@ -53,5 +56,8 @@ scpi_result_t SCPI_Flush(scpi_t * context);

scpi_result_t SCPI_SystemCommTcpipControlQ(scpi_t * context);

#ifdef __cplusplus
}
#endif
#endif /* __SCPI_DEF_H_ */

83 changes: 55 additions & 28 deletions examples/test-LwIP-netconn/scpi_server.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,6 @@
#include "lwip/tcp.h"
#include "lwip/inet.h"


#define DEVICE_PORT 5025
#define CONTROL_PORT 5026

#define SCPI_THREAD_PRIO (tskIDLE_PRIORITY + 2)

#define SCPI_MSG_TIMEOUT 0
Expand Down Expand Up @@ -94,7 +90,7 @@ size_t SCPI_Write(scpi_t * context, const char * data, size_t len) {
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;
Expand All @@ -112,16 +108,13 @@ scpi_result_t SCPI_Flush(scpi_t * context) {
}

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;
}
Expand All @@ -139,20 +132,20 @@ scpi_result_t SCPI_Control(scpi_t * context, scpi_ctrl_name_t ctrl, scpi_reg_val
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;
}

Expand Down Expand Up @@ -242,7 +235,7 @@ static void waitServer(user_data_t * user_data, queue_event_t * evt) {
}
}

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) {
Expand All @@ -252,7 +245,7 @@ static int processIoListen(user_data_t * user_data) {
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.
Expand All @@ -264,7 +257,7 @@ static int processIoListen(user_data_t * user_data) {
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) {
Expand All @@ -273,7 +266,7 @@ static int processSrqIoListen(user_data_t * user_data) {
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.
Expand All @@ -285,20 +278,20 @@ static int processSrqIoListen(user_data_t * user_data) {
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) {
Expand Down Expand Up @@ -387,10 +380,10 @@ static void scpi_server_thread(void *arg) {

scpi_context.user_context = &user_data;

user_data.io_listen = createServer(DEVICE_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(CONTROL_PORT);
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) {
Expand All @@ -401,19 +394,19 @@ static void scpi_server_thread(void *arg) {
}

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) {
Expand All @@ -435,3 +428,37 @@ void scpi_server_init(void) {
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 */
}
18 changes: 18 additions & 0 deletions examples/test-LwIP-netconn/scpi_server.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,35 @@

#ifndef _SCPI_SERVER_H_
#define _SCPI_SERVER_H_
#ifdef __cplusplus
extern "C" {
#endif

#define SCPI_KEEP_IDLE 2000 // (ms) keepalive quiet time after last TCP packet
#define SCPI_KEEP_INTVL 1000 // (ms) keepalive repeat interval
#define SCPI_KEEP_CNT 4 // Retry count before terminating connection (SCPI_KEEP_INTVL * SCPI_KEEP_INTVL (ms)).

#define SCPI_DEVICE_PORT 5025 // scpi-raw standard port
#define SCPI_CONTROL_PORT 5026 // libscpi control port (not part of the standard)

#include <stdint.h>
#include "lwip/api.h"
#include "scpi/types.h"

void scpi_server_init(void);

void SCPI_AddError(int16_t err);
void SCPI_RequestControl(void);

// optional event handlers
void SCPI_Event_DeviceConnected(scpi_t * context, struct netconn * conn);
void SCPI_Event_DeviceDisconnected(scpi_t * context, struct netconn * conn);
void SCPI_Event_ControlConnected(scpi_t * context, struct netconn * conn);
void SCPI_Event_ControlDisconnected(scpi_t * context, struct netconn * conn);
void SCPI_Event_ErrorIndicatorOn(scpi_t * context, int_fast16_t err);
void SCPI_Event_ErrorIndicatorOff(scpi_t * context, int_fast16_t err);

#ifdef __cplusplus
}
#endif
#endif /* _SCPI_SERVER_H_ */

0 comments on commit 42841c3

Please sign in to comment.