Updates and fixes to Component Framework code for Arduino on ARC

- Sync'd CFW code with Thunderdome code base from 01-July-2015
- Fixed issue with mailbox interrupts halting CPU, caused by bug in scss_registers.h
- Added CFW test service client to facilitate CFW sanity check (requires LMT build running Test service)

Signed-off-by: Dan O'Donovan <[email protected]>

Author: Dan-Lightsource

cores/arduino/wiring_constants.h

@@ -30,8 +30,12 @@ extern "C"{
 #define OUTPUT 0x1
 #define INPUT_PULLUP 0x2
 
+#ifndef true
 #define true 0x1
+#endif
+#ifndef false
 #define false 0x0
+#endif
 
 #define PI 3.1415926535897932384626433832795
 #define HALF_PI 1.5707963267948966192313216916398

system/libarc32_edu/Makefile

@@ -24,6 +24,7 @@ HWFLAGS=-mARCv2EM -mav2em -mlittle-endian
 
 CFGFLAGS=-DCONFIG_SOC_GPIO_32 -DINFRA_MULTI_CPU_SUPPORT -DCFW_MULTI_CPU_SUPPORT -DHAS_SHARED_MEM
 OPTFLAGS=-g -Os -Wall -Werror
+#CFGFLAGS+=-DCONFIG_CFW_SERVICES_TEST
 INCLUDES=-Icommon -Ibootcode -Iframework/include
 EXTRA_CFLAGS=-D__CPU_ARC__ -DCLOCK_SPEED=32 -fno-reorder-functions -fno-asynchronous-unwind-tables -fno-omit-frame-pointer -fno-defer-pop -Wno-unused-but-set-variable -Wno-main -ffreestanding -fno-stack-protector -mno-sdata -ffunction-sections -fdata-sections 
 CFLAGS=$(HWFLAGS) $(OPTFLAGS) $(EXTRA_CFLAGS) $(CFGFLAGS) $(INCLUDES)

system/libarc32_edu/bootcode/init.S

@@ -18,6 +18,9 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
 #include "aux_regs.h"
 
+.globl _do_fault
+.type _do_fault,%function
+
 .globl _do_isr
 .type _do_isr,%function
 

system/libarc32_edu/common/scss_registers.h

@@ -366,7 +366,7 @@
 #define SCSS_INT_MAILBOX_START_CHANNEL  0x00
 #elif defined(__CPU_ARC__)
 /* Second byte is for ARC */
-#define SCSS_INT_MAILBOX_START_CHANNEL  0x10
+#define SCSS_INT_MAILBOX_START_CHANNEL  0x8
 #endif
 
 #define SOC_MBX_INT_UNMASK(channel) SCSS_REG_VAL(SCSS_INT_MAILBOX_MASK) &= \

system/libarc32_edu/framework/include/cfw/cfw.h

@@ -1,6 +1,17 @@
+#ifndef _CFW_H_
+#define _CFW_H_
+
+#include <stdio.h>
+#include <stdlib.h>
+
+#include "os/os.h"
+#include "util/list.h"
+#include "infra/port.h"
+#include "infra/message.h"
+
 /**
- * \defgroup cfw CFW: Component Framework
- * \brief The component framework is the main building block for a custom application.
+ * @defgroup cfw CFW: Component Framework
+ * The Component Framework is the main building block for custom applications.
  *
  * It consists of:
  *  - Service APIs
@@ -12,20 +23,10 @@
  * order to be interfaced with it.
  * It could have other threads for its specific need and would have to manage
  * communication with the framework thread for interface with the rest of the platform.
+ *
  * @{
  */
 
-#ifndef _CFW_H_
-#define _CFW_H_
-
-#include <stdio.h>
-#include <stdlib.h>
-
-#include "os/os.h"
-#include "util/list.h"
-#include "infra/port.h"
-#include "infra/message.h"
-
 struct cfw_message {
 	struct message m;
 
@@ -74,6 +75,8 @@ typedef void * cfw_handle_t;
 typedef struct svc_client_handle_ {
 	/** Port to attain the service. */
 	uint16_t port;
+	/** Service id */
+	int service_id;
 	/** Framework handle. */
 	cfw_handle_t cfw_handle;
 	/** Pointer to store the server-side connection handle.
@@ -82,28 +85,6 @@ typedef struct svc_client_handle_ {
 	void * server_handle;
 } svc_client_handle_t;
 
-/**
- * Services id definitions
- *
- * Keep them numbered manually to avoid shifting on
- * removal/addition of services
- */
-enum {
-	FRAMEWORK_SERVICE_ID = 1,
-	TEST2_SERVICE_ID = 2,
-	TEST_SERVICE_ID = 3,
-	BLE_SERVICE_ID = 4,
-	BLE_CORE_SERVICE_ID = 5,
-};
-
-/**
- * Logging macro.
- */
-/*
- * Function Prototypes
- *
- */
-void cfw_log(char * fmt, ...);
 
 /**
  * \brief Allocate a memory buffer
@@ -176,27 +157,6 @@ int _find_service(int);
  */
 int _cfw_get_service_port(int);
 
-
-/*
- * Multi cpu APIs.
- */
-
-/**
- * \brief set the callback to be used to send a message to the given cpu.
- *
- * \param cpu_id the cpu id for which we want to set the handler.
- * \param handler the callback used to send a message to this cpu.
- */
-void set_cpu_message_sender(int cpu_id, int (*handler)(struct cfw_message * msg));
-
-/**
- * \brief set the callback to be used to request free a message to a cpu.
- *
- * \param cpu_id the cpu id for which we want to set the handler.
- * \param handler the callback used to request message free on.
- */
-void set_cpu_free_handler(int cpu_id, void (*free_handler)(void *));
+/** @} */
 
 #endif /* #ifndef _CFW_H_ */
-
-/**@}*/

system/libarc32_edu/framework/include/cfw/cfw_client.h

@@ -1,16 +1,15 @@
-/**
- * \addtogroup cfw
- * @{
- * \defgroup cfw_client CFW Client API
- * @{
- * \brief Definition of the structure and functions needed by CFW clients, i.e.
- * for users of services.
- */
-
 #ifndef __CFW_CLIENT_H__
 #define __CFW_CLIENT_H__
+
 #include "cfw/cfw.h"
 
+/**
+ * @defgroup cfw_client CFW Client API
+ * CFW Client API, i.e for users of services.
+ * @ingroup cfw
+ * @{
+ */
+
 /**
  * Create a handle to the component framework.
  * This handle is to be used for all other requests
@@ -84,9 +83,8 @@ int cfw_register_events(svc_client_handle_t * handle, int * msg_ids, int size, v
  * \param handle the framework handle.
  * \param param the private param sent back with the response message.
  */
-int cfw_register_svc_available(cfw_handle_t handle, void *param);
+int cfw_register_svc_available(cfw_handle_t handle, int service_id, void *param);
 
-#endif
-
-/**@} @}*/
+/** @} */
 
+#endif

system/libarc32_edu/framework/include/cfw/cfw_internal.h

@@ -24,7 +24,7 @@ typedef struct {
  *
  * \return the value to be passed as response to the requestor
  */
-int handle_ipc_sync_request(int cpu_id, int request, int param1,
+int handle_ipc_sync_request(uint8_t cpu_id, int request, int param1,
         int param2, void * ptr);
 
 #endif /* __CFW_INTERNAL_H__ */

system/libarc32_edu/framework/include/cfw/cfw_messages.h

@@ -28,6 +28,8 @@ typedef struct {
 	int service_id;
 	/** client side service handle */
 	void *client_handle;
+	/** client side cpu id, required for remote node services */
+	uint8_t client_cpu_id;
 } cfw_open_conn_req_msg_t;
 
 /**
@@ -40,7 +42,7 @@ typedef struct {
 	/** port to attain this service */
 	uint16_t port;
 	/** cpu_id of service */
-	int cpu_id;
+	uint8_t cpu_id;
 	/** service handle for accessing the service */
 	void * svc_server_handle;
 	/** client side service handle as passed in
@@ -55,6 +57,8 @@ typedef struct {
 typedef struct {
 	/** common message header */
 	struct cfw_message header;
+	/** service id to close */
+	int service_id;
 	/** service to open connection to */
 	void * inst;
 } cfw_close_conn_req_msg_t;
@@ -84,6 +88,11 @@ typedef struct {
 } cfw_register_evt_rsp_msg_t;
 
 
+typedef struct {
+	struct cfw_message header;
+	int service_id;
+} cfw_register_svc_avail_req_msg_t;
+
 typedef struct {
 	/** common response message header */
 	struct cfw_rsp_message rsp_header;
@@ -99,4 +108,6 @@ typedef struct {
     /** Service id of the newly available service. */
     int service_id;
 } cfw_svc_available_evt_msg_t;
+
+
 #endif /* __CFW_MESSAGE_H__ */

system/libarc32_edu/framework/include/cfw/cfw_service.h

@@ -1,13 +1,6 @@
-/**
- * \addtogroup cfw
- * @{
- * \defgroup cfw_service CFW Service API
- * @{
- * \brief Definition of the structure and functions used by CFW services implementation.
- */
-
 #ifndef __CFW_SERVICE_H_
 #define __CFW_SERVICE_H_
+
 #include "os/os.h"
 #include "cfw/cfw.h"
 #include "cfw/cfw_internal.h"
@@ -17,6 +10,13 @@
 struct service;
 struct _port;
 
+/**
+ * @defgroup cfw_service CFW Service API
+ * @brief CFW Service API.
+ * @ingroup cfw
+ * @{
+ */
+
 /**
  * \struct conn_handle_t
  *
@@ -56,14 +56,17 @@ typedef struct service {
 	void (*registered_events_changed)(conn_handle_t *);
 } service_t;
 
-int _cfw_register_service(service_t * svc);
-int _cfw_deregister_service(cfw_handle_t handle, service_t * svc);
 #ifdef CFW_MULTI_CPU_SUPPORT
 void _cfw_init_proxy(T_QUEUE queue, void * p, service_t**s, uint16_t svc_mgr_port);
 #endif
 service_t * cfw_get_service(int service_id);
 
-
+/**
+ * Gets the service manager port id.
+ *
+ * \return service manager port id
+ */
+uint16_t cfw_get_service_mgr_port_id(void);
 
 /**
  * Allocate and build a response message for a specific request.
@@ -135,6 +138,6 @@ int cfw_unregister_service(service_t * service);
  */
 void cfw_send_event(struct cfw_message * msg);
 
-#endif /* __CFW_SERVICE_H_ */
+/** @} */
 
-/**@} @}*/
+#endif /* __CFW_SERVICE_H_ */

system/libarc32_edu/framework/include/infra/ipc.h

@@ -1,4 +1,4 @@
-/** INTEL CONFIDENTIAL Copyright 2014 Intel Corporation All Rights Reserved.
+/* INTEL CONFIDENTIAL Copyright 2014 Intel Corporation All Rights Reserved.
   *
   * The source code contained or described herein and all documents related to
   * the source code ("Material") are owned by Intel Corporation or its suppliers
@@ -25,6 +25,7 @@
 #define __IPC_H__
 
 #include "infra/ipc_requests.h"
+#include "infra/message.h"
 
 /**
  * \brief initialize ipc component.
@@ -36,7 +37,7 @@
  * \param remote_cpu_id the remote cpu id of this IPC
  */
 void ipc_init(int tx_channel, int rx_channel, int tx_ack_channel,
-        int rx_ack_channel, int remote_cpu_id);
+        int rx_ack_channel, uint8_t remote_cpu_id);
 
 /**
  * \brief request a synchronous ipc call.
@@ -73,7 +74,34 @@ void ipc_handle_message();
  *
  * \return 0 if success, -1 otherwise
  */
-int ipc_sync_callback(int cpu_id, int request, int param1, int param2,
+int ipc_sync_callback(uint8_t cpu_id, int request, int param1, int param2,
 		void *ptr);
 
+/**
+ * \brief Called by port implementation when a message has to be sent to a
+ * CPU connected through the mailbox ipc mechanism.
+ *
+ * \param message the message to send to the other end
+ */
+int ipc_async_send_message(struct message *message);
+/**
+ * \brief Called by port implementation when a message that comes from a
+ * different CPU than ours has to be freed.
+ *
+ * \param message the message to be freed.
+ */
+void ipc_async_free_message(struct message *message);
+
+/**
+ * \brief initialize the async message sender / freeing mechanism for remote
+ * message sending and freeing.
+ *
+ * Async message sender / freeing is needed as message can be sent / freed in
+ * the context of interrupts. And in interrupt context, the ipc requests sync
+ * cannot be called.
+ *
+ * \param queue the queue on which context the ipc requests have to be called.
+ */
+void ipc_async_init(T_QUEUE queue);
+
 #endif

system/libarc32_edu/framework/include/infra/ipc_requests.h

@@ -9,5 +9,9 @@
 #define IPC_REQUEST_REGISTER_SERVICE   0x11
 #define IPC_REQUEST_DEREGISTER_SERVICE 0x12
 #define IPC_REQUEST_REG_TCMD_ENGINE    0x13
+#define IPC_REQUEST_REGISTER_PROXY     0x14
+#define IPC_PANIC_NOTIFICATION         0x15
+#define IPC_REQUEST_POWER_MANAGEMENT   0x16
+#define IPC_REQUEST_LOGGER             0x17
 
 #endif