Split Platform primitives from networking

Platforms using LwIP needs to use the "linux" implementation of networking.

Not every platform using LwIP has support for every linux primitives/syscalls (such as signal).

To allow the adoption in these kind of devices split the network from OS primitives.

Signed-off-by: Denis Benato <[email protected]>

Author: NeroReflex

MQTTClient-C/src/FreeRTOS/MQTTFreeRTOS.h

@@ -17,56 +17,7 @@
 #if !defined(MQTTFreeRTOS_H)
 #define MQTTFreeRTOS_H
 
-#include "FreeRTOS.h"
-#include "FreeRTOS_Sockets.h"
-#include "FreeRTOS_IP.h"
-#include "semphr.h"
-#include "task.h"
-
-typedef struct Timer 
-{
-	TickType_t xTicksToWait;
-	TimeOut_t xTimeOut;
-} Timer;
-
-typedef struct Network Network;
-
-struct Network
-{
-	xSocket_t my_socket;
-	int (*mqttread) (Network*, unsigned char*, int, int);
-	int (*mqttwrite) (Network*, unsigned char*, int, int);
-	void (*disconnect) (Network*);
-};
-
-void TimerInit(Timer*);
-char TimerIsExpired(Timer*);
-void TimerCountdownMS(Timer*, unsigned int);
-void TimerCountdown(Timer*, unsigned int);
-int TimerLeftMS(Timer*);
-
-typedef struct Mutex
-{
-	SemaphoreHandle_t sem;
-} Mutex;
-
-void MutexInit(Mutex*);
-int MutexLock(Mutex*);
-int MutexUnlock(Mutex*);
-
-typedef struct Thread
-{
-	TaskHandle_t task;
-} Thread;
-
-int ThreadStart(Thread*, void (*fn)(void*), void* arg);
-
-int FreeRTOS_read(Network*, unsigned char*, int, int);
-int FreeRTOS_write(Network*, unsigned char*, int, int);
-void FreeRTOS_disconnect(Network*);
-
-void NetworkInit(Network*);
-int NetworkConnect(Network*, char*, int);
-/*int NetworkConnectTLS(Network*, char*, int, SlSockSecureFiles_t*, unsigned char, unsigned int, char);*/
+#include "FreeRTOSPrimitives.h"
+#include "FreeRTOSNetwork.h"
 
 #endif

MQTTClient-C/src/FreeRTOS/MQTTFreeRTOS.c renamed to MQTTClient-C/src/FreeRTOS/MQTTFreeRTOSNetwork.c

@@ -15,76 +15,10 @@
  *    Ian Craggs - convert to FreeRTOS
  *******************************************************************************/
 
-#include "MQTTFreeRTOS.h"
+#include "MQTTFreeRTOSNetwork.h"
 
 
-int ThreadStart(Thread* thread, void (*fn)(void*), void* arg)
-{
-	int rc = 0;
-	uint16_t usTaskStackSize = (configMINIMAL_STACK_SIZE * 5);
-	UBaseType_t uxTaskPriority = uxTaskPriorityGet(NULL); /* set the priority as the same as the calling task*/
-
-	rc = xTaskCreate(fn,	/* The function that implements the task. */
-		"MQTTTask",			/* Just a text name for the task to aid debugging. */
-		usTaskStackSize,	/* The stack size is defined in FreeRTOSIPConfig.h. */
-		arg,				/* The task parameter, not used in this case. */
-		uxTaskPriority,		/* The priority assigned to the task is defined in FreeRTOSConfig.h. */
-		&thread->task);		/* The task handle is not used. */
-
-	return rc;
-}
-
-
-void MutexInit(Mutex* mutex)
-{
-	mutex->sem = xSemaphoreCreateMutex();
-}
-
-int MutexLock(Mutex* mutex)
-{
-	return xSemaphoreTake(mutex->sem, portMAX_DELAY);
-}
-
-int MutexUnlock(Mutex* mutex)
-{
-	return xSemaphoreGive(mutex->sem);
-}
-
-
-void TimerCountdownMS(Timer* timer, unsigned int timeout_ms)
-{
-	timer->xTicksToWait = timeout_ms / portTICK_PERIOD_MS; /* convert milliseconds to ticks */
-	vTaskSetTimeOutState(&timer->xTimeOut); /* Record the time at which this function was entered. */
-}
-
-
-void TimerCountdown(Timer* timer, unsigned int timeout) 
-{
-	TimerCountdownMS(timer, timeout * 1000);
-}
-
-
-int TimerLeftMS(Timer* timer) 
-{
-	xTaskCheckForTimeOut(&timer->xTimeOut, &timer->xTicksToWait); /* updates xTicksToWait to the number left */
-	return (timer->xTicksToWait < 0) ? 0 : (timer->xTicksToWait * portTICK_PERIOD_MS);
-}
-
-
-char TimerIsExpired(Timer* timer)
-{
-	return xTaskCheckForTimeOut(&timer->xTimeOut, &timer->xTicksToWait) == pdTRUE;
-}
-
-
-void TimerInit(Timer* timer)
-{
-	timer->xTicksToWait = 0;
-	memset(&timer->xTimeOut, '\0', sizeof(timer->xTimeOut));
-}
-
-
-int FreeRTOS_read(Network* n, unsigned char* buffer, int len, int timeout_ms)
+static int FreeRTOS_read(Network* n, unsigned char* buffer, int len, int timeout_ms)
 {
 	TickType_t xTicksToWait = timeout_ms / portTICK_PERIOD_MS; /* convert milliseconds to ticks */
 	TimeOut_t xTimeOut;
@@ -110,7 +44,7 @@ int FreeRTOS_read(Network* n, unsigned char* buffer, int len, int timeout_ms)
 }
 
 
-int FreeRTOS_write(Network* n, unsigned char* buffer, int len, int timeout_ms)
+static int FreeRTOS_write(Network* n, unsigned char* buffer, int len, int timeout_ms)
 {
 	TickType_t xTicksToWait = timeout_ms / portTICK_PERIOD_MS; /* convert milliseconds to ticks */
 	TimeOut_t xTimeOut;
@@ -136,7 +70,7 @@ int FreeRTOS_write(Network* n, unsigned char* buffer, int len, int timeout_ms)
 }
 
 
-void FreeRTOS_disconnect(Network* n)
+static void FreeRTOS_disconnect(Network* n)
 {
 	FreeRTOS_closesocket(n->my_socket);
 }

MQTTClient-C/src/FreeRTOS/MQTTFreeRTOSNetwork.h

@@ -0,0 +1,40 @@
+/*******************************************************************************
+ * Copyright (c) 2014, 2015 IBM Corp.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ *    http://www.eclipse.org/legal/epl-v10.html
+ * and the Eclipse Distribution License is available at
+ *   http://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * Contributors:
+ *    Allan Stockdill-Mander - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+
+#if !defined(MQTTFreeRTOSNetwork_H)
+#define MQTTFreeRTOS_H
+
+#include "FreeRTOS.h"
+#include "FreeRTOS_Sockets.h"
+#include "FreeRTOS_IP.h"
+#include "semphr.h"
+#include "task.h"
+
+typedef struct Network Network;
+
+struct Network
+{
+	xSocket_t my_socket;
+	int (*mqttread) (Network*, unsigned char*, int, int);
+	int (*mqttwrite) (Network*, unsigned char*, int, int);
+	void (*disconnect) (Network*);
+};
+
+void NetworkInit(Network*);
+int NetworkConnect(Network*, char*, int);
+/*int NetworkConnectTLS(Network*, char*, int, SlSockSecureFiles_t*, unsigned char, unsigned int, char);*/
+
+#endif

MQTTClient-C/src/FreeRTOS/MQTTFreeRTOSPrimitives.c

@@ -0,0 +1,86 @@
+/*******************************************************************************
+ * Copyright (c) 2014, 2015 IBM Corp.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ *    http://www.eclipse.org/legal/epl-v10.html
+ * and the Eclipse Distribution License is available at
+ *   http://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * Contributors:
+ *    Allan Stockdill-Mander - initial API and implementation and/or initial documentation
+ *    Ian Craggs - convert to FreeRTOS
+ *******************************************************************************/
+
+#include "MQTTFreeRTOSPrimitives.h"
+
+#include <string.h>
+
+
+int ThreadStart(Thread* thread, void (*fn)(void*), void* arg)
+{
+	int rc = 0;
+	uint16_t usTaskStackSize = (configMINIMAL_STACK_SIZE * 5);
+	UBaseType_t uxTaskPriority = uxTaskPriorityGet(NULL); /* set the priority as the same as the calling task*/
+
+	rc = xTaskCreate(fn,	/* The function that implements the task. */
+		"MQTTTask",			/* Just a text name for the task to aid debugging. */
+		usTaskStackSize,	/* The stack size is defined in FreeRTOSIPConfig.h. */
+		arg,				/* The task parameter, not used in this case. */
+		uxTaskPriority,		/* The priority assigned to the task is defined in FreeRTOSConfig.h. */
+		&thread->task);		/* The task handle is not used. */
+
+	return rc;
+}
+
+
+void MutexInit(Mutex* mutex)
+{
+	mutex->sem = xSemaphoreCreateMutex();
+}
+
+int MutexLock(Mutex* mutex)
+{
+	return xSemaphoreTake(mutex->sem, portMAX_DELAY);
+}
+
+int MutexUnlock(Mutex* mutex)
+{
+	return xSemaphoreGive(mutex->sem);
+}
+
+
+void TimerCountdownMS(Timer* timer, unsigned int timeout_ms)
+{
+	timer->xTicksToWait = timeout_ms / portTICK_PERIOD_MS; /* convert milliseconds to ticks */
+	vTaskSetTimeOutState(&timer->xTimeOut); /* Record the time at which this function was entered. */
+}
+
+
+void TimerCountdown(Timer* timer, unsigned int timeout) 
+{
+	TimerCountdownMS(timer, timeout * 1000);
+}
+
+
+int TimerLeftMS(Timer* timer) 
+{
+	xTaskCheckForTimeOut(&timer->xTimeOut, &timer->xTicksToWait); /* updates xTicksToWait to the number left */
+	return (timer->xTicksToWait < 0) ? 0 : (timer->xTicksToWait * portTICK_PERIOD_MS);
+}
+
+
+char TimerIsExpired(Timer* timer)
+{
+	return xTaskCheckForTimeOut(&timer->xTimeOut, &timer->xTicksToWait) == pdTRUE;
+}
+
+
+void TimerInit(Timer* timer)
+{
+	timer->xTicksToWait = 0;
+	memset(&timer->xTimeOut, '\0', sizeof(timer->xTimeOut));
+}

MQTTClient-C/src/FreeRTOS/MQTTFreeRTOSPrimitives.h

@@ -0,0 +1,58 @@
+/*******************************************************************************
+ * Copyright (c) 2014, 2015 IBM Corp.
+ *
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * and Eclipse Distribution License v1.0 which accompany this distribution.
+ *
+ * The Eclipse Public License is available at
+ *    http://www.eclipse.org/legal/epl-v10.html
+ * and the Eclipse Distribution License is available at
+ *   http://www.eclipse.org/org/documents/edl-v10.php.
+ *
+ * Contributors:
+ *    Allan Stockdill-Mander - initial API and implementation and/or initial documentation
+ *******************************************************************************/
+
+#if !defined(MQTTFreeRTOS_H)
+#define MQTTFreeRTOS_H
+
+#if defined(ESP_PLATFORM)
+#include <freertos/FreeRTOS.h>
+#include <freertos/semphr.h>
+#include <freertos/task.h>
+#else
+#include "FreeRTOS.h"
+#include "semphr.h"
+#include "task.h"
+#endif
+
+typedef struct Timer 
+{
+	TickType_t xTicksToWait;
+	TimeOut_t xTimeOut;
+} Timer;
+
+void TimerInit(Timer*);
+char TimerIsExpired(Timer*);
+void TimerCountdownMS(Timer*, unsigned int);
+void TimerCountdown(Timer*, unsigned int);
+int TimerLeftMS(Timer*);
+
+typedef struct Mutex
+{
+	SemaphoreHandle_t sem;
+} Mutex;
+
+void MutexInit(Mutex*);
+int MutexLock(Mutex*);
+int MutexUnlock(Mutex*);
+
+typedef struct Thread
+{
+	TaskHandle_t task;
+} Thread;
+
+int ThreadStart(Thread*, void (*fn)(void*), void* arg);
+
+#endif

MQTTClient-C/src/linux/MQTTLinux.h

@@ -17,16 +17,7 @@
 #if !defined(__MQTT_LINUX_)
 #define __MQTT_LINUX_
 
-#if defined(WIN32_DLL) || defined(WIN64_DLL)
-  #define DLLImport __declspec(dllimport)
-  #define DLLExport __declspec(dllexport)
-#elif defined(LINUX_SO)
-  #define DLLImport extern
-  #define DLLExport  __attribute__ ((visibility ("default")))
-#else
-  #define DLLImport
-  #define DLLExport
-#endif
+#include "MQTTLinuxDllexport.h"
 
 #include <sys/types.h>
 #include <sys/socket.h>
@@ -46,29 +37,7 @@
 #include <string.h>
 #include <signal.h>
 
-typedef struct Timer
-{
-	struct timeval end_time;
-} Timer;
-
-void TimerInit(Timer*);
-char TimerIsExpired(Timer*);
-void TimerCountdownMS(Timer*, unsigned int);
-void TimerCountdown(Timer*, unsigned int);
-int TimerLeftMS(Timer*);
-
-typedef struct Network
-{
-	int my_socket;
-	int (*mqttread) (struct Network*, unsigned char*, int, int);
-	int (*mqttwrite) (struct Network*, unsigned char*, int, int);
-} Network;
-
-int linux_read(Network*, unsigned char*, int, int);
-int linux_write(Network*, unsigned char*, int, int);
-
-DLLExport void NetworkInit(Network*);
-DLLExport int NetworkConnect(Network*, char*, int);
-DLLExport void NetworkDisconnect(Network*);
+#include "MQTTLinuxNetwork.h"
+#include "MQTTLinuxPrimitives.h"
 
 #endif