[ulog] Enable by default and add example "SysLog"

- Modify drivers to use ulog
- Update metafiles

Author: onelife

README.md

@@ -6,12 +6,45 @@ Currently most of the optional components are removed for the sake of simplicity
 
 
 ## Available Components ##
-* FinSH (Support history and autocompletion)
+
+* FinSH (A tiny shell)
+  - Support history
+  - Support autocompletion
+  - Support user defined commands
+  - Support user defined variables
+
+* MSH (Module Shell)
+  - More in line with Unix shell's usage habits
+  - Smaller memory footprint than FinSH
+  - Support history
+  - Support autocompletion
+  - Support user defined commands
+
+* uLog (Micro logging system)
+  - Very useful debug tool
+
+* FAT filesystem
+  - Support exFAT (off by default)
+  - Support long filename (off by default)
+  - Support non-English characters (off by default)
+  - Support opening multiple files (4 by default)
+
+* SPI SD driver
+  - Enabled by default for MKRZero board
+
 
 ## Supported Architectures ##
 * SAM (ARM Cortex-M3, Tested with Arduino Due)
 * SAMD (ARM Cortex-M0+, Tested with Arduino MKRZero)
 
 
+## License  ##
+
+| Module     | License |
+| ---      | ---       |
+| RT-Thread core | Apache License 2.0 |
+| FatFS | FatFs (BSD like) License |
+
+
 ## Known Issues ##
 None

examples/FinSH/FinSH.ino

@@ -18,7 +18,7 @@
 // state=0
 // led(id, state)
 
-// NOTES: When using FinSH with MSH (CONFIG_USING_MSH == 1)
+// NOTES: When using FinSH with MSH (CONFIG_USING_MSH == 1, the default config)
 // - please append the following line to "shell_cmd.h" (without //)
 // ADD_MSH_CMD(led, Turn on/off builtin LED, led, rt_uint32_t, rt_uint32_t id, rt_uint8_t state)
 // Due to MSH doesn't support shell variables, "ADD_SHELL_VAR" has no effect

examples/SysLog/SysLog.ino

@@ -0,0 +1,40 @@
+#include <rtt.h>
+#define LOG_LVL LOG_LVL_DBG
+#define LOG_TAG "EXAMPLE"
+#include <log.h>
+
+// NOTES: "LOG_LVL" and "LOG_TAG" must be defined before "#include <log.h>"
+// Available LOG_LVL:
+// - LOG_LVL_ASSERT
+// - LOG_LVL_ERROR
+// - LOG_LVL_WARNING
+// - LOG_LVL_INFO
+// - LOG_LVL_DBG
+
+// NOTES: "CONFIG_USING_FINSH" and "CONFIG_USING_SPISD" in "rtconfig.h" may be turned off to save memory
+
+
+// RT-Thread function called by "RT_T.begin()"
+void rt_setup(void) {
+}
+
+void setup() {
+  RT_T.begin();
+}
+
+// this function will be called by "Arduino" thread
+void loop() {
+  char msg[] = "message here";
+  char hex[] = "this is a hex message: \x01\x02\x03\x0a\x0b\x0c";
+
+  LOG_E("Error %s", msg);
+  LOG_W("Warning %s", msg);
+  LOG_I("Information %s", msg);
+  LOG_D("Debug %s", msg); 
+  LOG_RAW("Raw %s, without makeup\n", msg);
+  LOG_HEX("hex_dump", 16, (rt_uint8_t *)hex, sizeof(hex));
+
+  LOG_I("System will stop after ASSERT failed");
+  ASSERT(1 == 0); // the system will stop here
+  LOG_I("Never reach here");
+}

keywords.txt

@@ -72,6 +72,17 @@ rt_mutex_release			KEYWORD2
 #######################################
 fsync						KEYWORD2
 
+#######################################
+# uLog
+#######################################
+LOG_E						KEYWORD2
+LOG_W						KEYWORD2
+LOG_I						KEYWORD2
+LOG_D						KEYWORD2
+LOG_RAW						KEYWORD2
+LOG_HEX						KEYWORD2
+ASSERT						KEYWORD2
+
 #######################################
 # Instances (KEYWORD2)
 #######################################
@@ -80,13 +91,25 @@ RT_T		KEYWORD2
 #######################################
 # Constants (LITERAL1)
 #######################################
+
+#######################################
+# User Config
+#######################################
 CONFIG_HEAP_SIZE			LITERAL1
 CONFIG_PRIORITY_MAX			LITERAL1
 CONFIG_KERNEL_PRIORITY		LITERAL1
 CONFIG_USING_CONSOLE		LITERAL1
 CONFIG_USING_FINSH			LITERAL1
 CONFIG_SERIAL_DEVICE		LITERAL1
+
+#######################################
+# Type
+#######################################
 RT_NULL						LITERAL1
+
+#######################################
+# Error
+#######################################
 RT_EOK						LITERAL1
 RT_ERROR					LITERAL1
 RT_ETIMEOUT					LITERAL1
@@ -98,7 +121,20 @@ RT_EBUSY					LITERAL1
 RT_EIO						LITERAL1
 RT_EINTR					LITERAL1
 RT_EINVAL					LITERAL1
+
+#######################################
+# IPC
+#######################################
 RT_IPC_FLAG_FIFO			LITERAL1
 RT_IPC_FLAG_PRIO			LITERAL1
 RT_WAITING_FOREVER			LITERAL1
 RT_WAITING_NO				LITERAL1
+
+#######################################
+# uLog
+#######################################
+LOG_LVL_ASSERT				LITERAL1
+LOG_LVL_ERROR				LITERAL1
+LOG_LVL_WARNING				LITERAL1
+LOG_LVL_INFO				LITERAL1
+LOG_LVL_DBG					LITERAL1

library.properties

@@ -1,5 +1,5 @@
 name=RT-Thread
-version=0.4.5
+version=0.5.0
 author=Bernard Xiong <[email protected]>, onelife <[email protected]>
 maintainer=onelife <[email protected]>
 sentence=Real Time Operating System porting for Arduino SAM and SAMD boards

src/components/arduino/drv_spi.cpp

@@ -25,29 +25,40 @@ extern "C" {
 
 /* Private typedef -----------------------------------------------------------*/
 /* Private define ------------------------------------------------------------*/
-#ifdef BSP_SPI_DEBUG
-#define spi_debug(format, args...)  rt_kprintf(format, ##args)
-#else
-#define spi_debug(format, args...)
-#endif
+#ifdef RT_USING_ULOG
+# ifdef BSP_SPI_DEBUG
+#  define LOG_LVL                   LOG_LVL_DBG
+# else
+#  define LOG_LVL                   LOG_LVL_INFO
+# endif
+# define LOG_TAG                    "SPI"
+# include "components/utilities/ulog/ulog.h"
+#else /* RT_USING_ULOG */
+# define LOG_E                      rt_kprintf
+# ifdef BSP_SPI_DEBUG
+#  define LOG_D(format, args...)    rt_kprintf(format "\n", ##args)
+# else
+#  define LOG_D(format, args...)
+# endif
+#endif /* RT_USING_ULOG */
 
 #if CONFIG_USING_SPI0
-#define SPI0                        SPI
+# define SPI0                       SPI
 #endif
 #define SPI_NAME(ch)                "SPI"#ch
 #define SPI_CTX(idx)                spi_ctx[idx]
 #define SPI_DEV(ctx)                ((SPIClass *)((ctx)->ldev))
-#define SPI_START(ctx)              spi_debug("SPI%d: START\n", ctx->chn); \
+#define SPI_START(ctx)              LOG_D("[SPI%d] START", ctx->chn); \
                                     SPI_DEV(ctx)->beginTransaction(ctx->set)
-#define SPI_STOP(ctx)               spi_debug("SPI%d: STOP\n", ctx->chn); \
+#define SPI_STOP(ctx)               LOG_D("[SPI%d] STOP", ctx->chn); \
                                     SPI_DEV(ctx)->endTransaction()
 #define SPI_TX(ctx, data)           (void)SPI_DEV(ctx)->transfer((rt_uint8_t)data)
 #define SPI_RX(ctx)                 SPI_DEV(ctx)->transfer(0xff)
 #define SPI_SET_SPEED(ctx, target)  \
 if (target != ctx->spd) { \
     ctx->set = SPISettings(target, MSBFIRST, SPI_MODE0); \
     ctx->spd = target; \
-    spi_debug("SPI%d: speed=%d\n", ctx->chn, target); \
+    LOG_D("[SPI%d] speed=%d", ctx->chn, target); \
 }
 
 /* Private variables ---------------------------------------------------------*/
@@ -62,7 +73,7 @@ static rt_bool_t wait_idle(struct bsp_spi_contex *ctx) {
         if (0xff == SPI_RX(ctx)) break;
     }
 
-    spi_debug("SPI%d: wait %d\n", ctx->chn, i);
+    LOG_D("[SPI%d] wait %d", ctx->chn, i);
     return (i < SPI_DEFAULT_LIMIT);
 }
 
@@ -73,7 +84,7 @@ static rt_bool_t wait_token(struct bsp_spi_contex *ctx, rt_uint8_t token) {
         if (token == SPI_RX(ctx)) break;
     }
 
-    spi_debug("SPI%d: wait token %d\n", ctx->chn, i);
+    LOG_D("[SPI%d] wait token %d", ctx->chn, i);
     return (i < SPI_DEFAULT_LIMIT);
 }
 
@@ -86,11 +97,11 @@ static rt_err_t bsp_spi_open(rt_device_t dev, rt_uint16_t oflag) {
         if (RT_EOK != ret) break;
 
         ctx->dev.open_flag = oflag & RT_DEVICE_OFLAG_MASK;
-        spi_debug("SPI%d: open with flag %x\n", ctx->chn, oflag);
+        LOG_D("[SPI%d] open with flag %x", ctx->chn, oflag);
     } while (0);
 
     if (RT_EOK != ret) {
-        spi_debug("SPI%d err: open failed [%08x]\n", ctx->chn, ret);
+        LOG_D("[SPI%d E] open failed [%08x]", ctx->chn, ret);
     }
     return ret;
 }
@@ -103,11 +114,11 @@ static rt_err_t bsp_spi_close(rt_device_t dev) {
         ret = rt_mutex_release(&ctx->lok);
         if (RT_EOK != ret) break;
 
-        spi_debug("SPI%d: closed\n", ctx->chn);
+        LOG_D("[SPI%d] closed", ctx->chn);
     } while (0);
 
     if (RT_EOK != ret) {
-        spi_debug("SPI%d err: close failed [%08x]\n", ctx->chn, ret);
+        LOG_D("[SPI%d E] close failed [%08x]", ctx->chn, ret);
     }
     return ret;
 }
@@ -134,7 +145,7 @@ static rt_size_t bsp_spi_read(rt_device_t dev, rt_off_t token, void *buf,
 
         if (RT_NULL == buf) {
             /* dummy read */
-            spi_debug("SPI%d: dummy read [%d]\n", ctx->chn, size);
+            LOG_D("[SPI%d] dummy read [%d]", ctx->chn, size);
             SPI_START(ctx);
             for (i = 0; i < size; i++) (void)SPI_RX(ctx);
             SPI_STOP(ctx);
@@ -161,24 +172,24 @@ static rt_size_t bsp_spi_read(rt_device_t dev, rt_off_t token, void *buf,
             if (i >= SPI_DEFAULT_RETRY) {
                 SPI_STOP(ctx);
                 err = -RT_EBUSY;
-                spi_debug("SPI%d err: read busy\n", ctx->chn);
+                LOG_D("[SPI%d E] read busy", ctx->chn);
                 break;
             }
 
             /* send instruction */
-            spi_debug("SPI%d: tx ins [%d]\n", ctx->chn, inst_len);
+            LOG_D("[SPI%d] tx ins [%d]", ctx->chn, inst_len);
             for (i = 0; i < inst_len; i++)
                 SPI_TX(ctx, *(inst_ptr + i));
 
             /* receive data */
-            spi_debug("SPI%d: rx data [%d]\n", ctx->chn, size);
+            LOG_D("[SPI%d] rx data [%d]", ctx->chn, size);
             if (0 != token) {
                 for (i = 0; i < SPI_DEFAULT_RETRY; i++)
                     if (wait_token(ctx, (rt_uint8_t)token)) break;
                 if (i >= SPI_DEFAULT_RETRY) {
                     SPI_STOP(ctx);
                     err = -RT_EIO;
-                    spi_debug("SPI%d err: no token\n", ctx->chn);
+                    LOG_D("[SPI%d E] no token", ctx->chn);
                     break;
                 }
             }
@@ -237,17 +248,17 @@ static rt_size_t bsp_spi_write(rt_device_t dev, rt_off_t pos, const void *buf,
         if (i >= SPI_DEFAULT_RETRY) {
             SPI_STOP(ctx);
             err = -RT_EBUSY;
-            spi_debug("SPI%d err: write busy\n", ctx->chn);
+            LOG_D("[SPI%d E] write busy", ctx->chn);
             break;
         }
 
         /* send instruction */
-        spi_debug("SPI%d: tx ins [%d]\n", ctx->chn, inst_len);
+        LOG_D("[SPI%d] tx ins [%d]", ctx->chn, inst_len);
         for (i = 0; i < inst_len; i++)
             SPI_TX(ctx, *(inst_ptr + i));
 
         /* send data */
-        spi_debug("SPI%d: tx data [%d]\n", ctx->chn, size);
+        LOG_D("[SPI%d] tx data [%d]", ctx->chn, size);
         for (i = 0; i < size; i++)
             SPI_TX(ctx, *(tx_buf + i));
         SPI_STOP(ctx);
@@ -382,11 +393,11 @@ rt_err_t bsp_hw_spi_init(void) {
         if (RT_EOK != ret) break;
 
         SPI_DEV(&SPI_CTX(i))->begin();
-        spi_debug("SPI%d: h/w init ok!\n", chn);
+        LOG_D("[SPI%d] h/w init ok!", chn);
     }
 
     if (RT_EOK != ret)
-        rt_kprintf("SPI%d err: h/w init failed!\n", chn);
+        LOG_E("[SPI%d E] h/w init failed!", chn);
 
     return ret;
 }