Merged buffer size in config

Author: ConradBraam

TEST_APPS/device/nfcapp/main.cpp

@@ -65,7 +65,7 @@ const char *errorcodes = // descriptions from nfc/stack/nfc_errors.h
     "20 NFC_ERR_DISCONNECTED \n"
     "21 NFC_ERR_ABORTED\n";
 
-// for easy manual UI interaction
+/** Disables VT100 etc. for easy manual UI interaction */
 int seteasy(int argc, char *argv[])
 {
     const char msg[][20] =
@@ -95,15 +95,17 @@ int main(int argc, char *argv[])
             "last NFC error code", errorcodes);
     cmd_add("setlastnfcerror", HandleTestCommand::cmd_set_last_nfc_error,
             "self-test", "for self-test only");
+    cmd_add("iseeprom", HandleTestCommand::cmd_get_conf_nfceeprom,
+            "get NFC configEEPROM  present",
+            "true if config exists, else false");
     cmd_add("initnfc", HandleTestCommand::cmd_init_nfc, "init NFC driver",
             "call first");
+    cmd_add("getmaxndef", HandleTestCommand::cmd_get_max_ndef, "get max NDEF record target supports",
+            "returns the eeprom size, or max buffer if a controller");
     cmd_add("init", HandleTestCommand::cmd_init_nfc, "alias initnfc",
             "call first");
     cmd_add("setsmartposter", HandleTestCommand::cmd_set_smartposter,
             "send smartposter NDEF", "<uri>");
-    cmd_add("iseeprom", HandleTestCommand::cmd_get_conf_nfceeprom,
-            "get NFC configEEPROM  present",
-            "true if config exists, else false");
     cmd_add("readmessage", HandleTestCommand::cmd_read_message,
             "read EEPROM else return last message", "returns hex dump");
     cmd_add("read", HandleTestCommand::cmd_read_message, "alias readmessage",

TEST_APPS/device/nfcapp/mbed_app.json

@@ -1,6 +1,6 @@
 {
     "config": {
-        "TEST_NDEF_MSG_MAX" : 8192
+        "TEST_NDEF_MSG_MAX" : 1024
     },
     "target_overrides": {
         "DISCO_L475VG_IOT01A": {

TEST_APPS/device/nfcapp/nfccommands.cpp

@@ -68,6 +68,17 @@ int HandleTestCommand::cmd_set_last_nfc_error(int argc, char *argv[])
     return (CMDLINE_RETCODE_EXCUTING_CONTINUE);
 }
 
+
+int HandleTestCommand::cmd_get_max_ndef(int argc, char *argv[])
+{
+    if (pNFC_Test_Shim) {
+        nfcQueue.call(pNFC_Test_Shim, &NFCTestShim::cmd_get_max_ndef);
+        return CMDLINE_RETCODE_EXCUTING_CONTINUE;
+    }
+    return CMDLINE_RETCODE_FAIL;
+}
+
+
 int HandleTestCommand::cmd_init_nfc(int argc, char *argv[])
 {
 
@@ -82,7 +93,7 @@ int HandleTestCommand::cmd_init_nfc(int argc, char *argv[])
 
 int HandleTestCommand::cmd_read_message(int argc, char *argv[])
 {
-    nfcQueue.call(pNFC_Test_Shim, &NFCTestShim::cmd_read_nfceeprom);
+    nfcQueue.call(pNFC_Test_Shim, &NFCTestShim::cmd_read_nfc_contents);
 
     return (CMDLINE_RETCODE_EXCUTING_CONTINUE);
 }
@@ -133,6 +144,12 @@ int HandleTestCommand::cmd_write_long_ndef_message(int argc, char *argv[])
         cmd_printf("Cannot convert value to int\r\n");
         return (CMDLINE_RETCODE_INVALID_PARAMETERS);
     }
+    // check that it would not overflow
+    if (length > MBED_CONF_APP_TEST_NDEF_MSG_MAX) {
+        cmd_printf("Buffer length may not exceed %d !\r\n", (int)MBED_CONF_APP_TEST_NDEF_MSG_MAX);
+        return (CMDLINE_RETCODE_FAIL);
+    }
+
     data = (char *) malloc(length + 1);
     if (!data) {
         cmd_printf("WARN out of memory!\r\n");

TEST_APPS/device/nfcapp/nfccommands.h

@@ -38,44 +38,49 @@ extern events::EventQueue nfcQueue;
  */
 class HandleTestCommand {
 public:
-    // start thread and handle queue
     HandleTestCommand();
-    /* set corresponding mask bit on, return false if the supplied string cannot parse */
+    /** set corresponding mask bit on in referenced structure, return false if the supplied string cannot parse */
     static bool set_protocol_target(mbed::nfc::nfc_rf_protocols_bitmask_t &bitmask, const char *protocolName);
 
-    /* return and clear the last result code. Type "help getlastnfcerror" for a list of error codes */
+    /** return and clear the last result code. Type "help getlastnfcerror" for a list of error codes */
     static int cmd_get_last_nfc_error(int argc, char *argv[])
     {
         nfcQueue.call(NFCTestShim::cmd_get_last_nfc_error);
         return (CMDLINE_RETCODE_EXCUTING_CONTINUE);
     }
 
-    /* internal function to test getlastnfcerror */
+    /** internal function to test getlastnfcerror */
     static int cmd_set_last_nfc_error(int argc, char *argv[]);
 
-    /* compile time flag */
+    /** returns compile time flag if NFC EEPROM was compiled */
     static int cmd_get_conf_nfceeprom(int argc, char *argv[])
     {
         nfcQueue.call(NFCTestShim::cmd_get_conf_nfceeprom);
         return (CMDLINE_RETCODE_EXCUTING_CONTINUE);
     }
 
-    /* must be called before invoking any other calls */
+    /** For EEPROM, returns the driver max_ndef value, else returns the app config MBED_CONF_APP_TEST_NDEF_MSG_MAX */
+    static int cmd_get_max_ndef(int argc, char *argv[]);
+
+    /** Init must be called before invoking any other calls, obtains a driver reference and initializes driver */
     static int cmd_init_nfc(int argc, char *argv[]);
-    /* write a smartposter url, 'Sp' NDEF to the target */
+    /** write a smartposter url, 'Sp' NDEF to the target */
     static int cmd_set_smartposter(int argc, char *argv[]);
-    /* erase EEPROM */
+    /** erases the EEPROM if present */
     static int cmd_erase(int argc, char *argv[]);
 
-    // controller driver methods:
+    /** Returns a CSV list of protocols supported */
     static int cmd_get_supported_rf_protocols(int argc, char *argv[]);
+    /** Sets the protocols supported (unimplemented) */
     static int cmd_configure_rf_protocols(int argc, char *argv[]);
+    /** starts the NFC discovery loop if controller, has no effect on EEPROM */
     static int cmd_start_discovery(int argc, char *argv[]);
+    /** stops the NFC discovery loop if controller */
     static int cmd_stop_discovery(int argc, char *argv[]);
 
-    /* read raw EEPROM contents */
+    /** read raw EEPROM contents, reads a buffer if a controller is used */
     static int cmd_read_message(int argc, char *argv[]);
-    /* write a text 'T' NDEF message to the target */
+    /** write a text 'T' NDEF message to the target */
     static int cmd_write_long_ndef_message(int argc, char *argv[]);
 
 };

TEST_APPS/device/nfcapp/nfcprocessCtrl.h

@@ -48,6 +48,11 @@ class NFCProcessController: NFCTestShim,
 public:
     NFCProcessController(events::EventQueue &queue);
 
+    void cmd_get_max_ndef()
+    {
+        cmd_printf("{{maxndef=%d}}\r\n", (int)MBED_CONF_APP_TEST_NDEF_MSG_MAX);
+        cmd_ready(CMDLINE_RETCODE_SUCCESS);
+    }
     nfc_err_t init();
     nfc_err_t start_discovery();
     nfc_err_t stop_discovery();

TEST_APPS/device/nfcapp/nfcprocessEeprom.cpp

@@ -47,7 +47,7 @@ using mbed::nfc::NFCEEPROMDriver;
 
 // implements : mbed::nfc::NFCEEPROM::Delegate
 NFCProcessEEPROM::NFCProcessEEPROM(events::EventQueue &queue, NFCEEPROMDriver &eeprom_driver) :
-    NFCTestShim(queue), _eeprom(&eeprom_driver, &queue, _ndef_buffer)
+    NFCTestShim(queue), _eeprom(&eeprom_driver, &queue, _ndef_buffer), _ptr_eeprom_driver(&eeprom_driver)
 {}
 
 nfc_err_t NFCProcessEEPROM::init()
@@ -63,6 +63,13 @@ nfc_err_t NFCProcessEEPROM::init()
     return (err);
 }
 
+
+void NFCProcessEEPROM::cmd_get_max_ndef()
+{
+    cmd_printf("{{maxndef=%d}}\r\n", (int)_ptr_eeprom_driver->read_max_size());
+    cmd_ready(CMDLINE_RETCODE_SUCCESS);
+}
+
 void NFCProcessEEPROM::queue_write_call()
 {
     cmd_printf("NFCProcessEEPROM::queue_write_call() entry\r\n");
@@ -83,7 +90,6 @@ void NFCProcessEEPROM::queue_erase_call()
 
 void NFCProcessEEPROM::on_ndef_message_written(nfc_err_t result)
 {
-    // todo: de-duplicate this code
     set_last_nfc_error(result);
     if (result == NFC_OK) {
         cmd_printf("message written successfully\r\n");
@@ -108,7 +114,6 @@ void NFCProcessEEPROM::on_ndef_message_read(nfc_err_t result)
 
 void NFCProcessEEPROM::on_ndef_message_erased(nfc_err_t result)
 {
-    // todo : de-duplicate/template this callback handler
     set_last_nfc_error(result);
     if (result == NFC_OK) {
         cmd_printf("message erased successfully\r\n");

TEST_APPS/device/nfcapp/nfcprocessEeprom.h

@@ -43,6 +43,8 @@ class NFCProcessEEPROM : NFCTestShim, mbed::nfc::NFCEEPROM::Delegate {
     void queue_write_long_call();
     void queue_read_call();
     void queue_erase_call();
+    void cmd_get_max_ndef();
+
 
 private:
     virtual void on_ndef_message_written(nfc_err_t result);
@@ -52,6 +54,7 @@ class NFCProcessEEPROM : NFCTestShim, mbed::nfc::NFCEEPROM::Delegate {
     virtual void on_ndef_message_erased(nfc_err_t result);
 private:
     mbed::nfc::NFCEEPROM _eeprom;
+    mbed::nfc::NFCEEPROMDriver *_ptr_eeprom_driver;
 };
 
 #endif //  eeprom

TEST_APPS/device/nfcapp/nfctestshim.cpp

@@ -42,7 +42,6 @@ using mbed::nfc::nfc_rf_protocols_bitmask_t;
 // statics
 namespace {
 char long_string[MBED_CONF_APP_TEST_NDEF_MSG_MAX];
-
 char const   *uri_prefix_string[] = { "",
                                       "http://www.",
                                       "https://www.",
@@ -234,18 +233,19 @@ void NFCTestShim::cmd_configure_rf_protocols(
   * the framework
   * \return void An ICETEA error code and NFC error is set asyncronously
   */
-void NFCTestShim::cmd_read_nfceeprom()
+void NFCTestShim::cmd_read_nfc_contents()
 {
 #if MBED_CONF_NFCEEPROM
     ((NFCProcessEEPROM *)this)->queue_read_call();
-    cmd_printf("NFCTestShim::read_nfceeprom() exit\r\n");
+    cmd_printf("NFCTestShim::cmd_read_nfc_contents() exit\r\n");
 
 #else
     // returns last message "written", since we cannot read
     print_ndef_message(_ndef_write_buffer, _ndef_write_buffer_used);
+    cmd_printf("Controller buffer data size=%d\r\n", _ndef_write_buffer_used);
     set_last_nfc_error(NFC_OK);
 
-    cmd_printf("NFCTestShim::read_nfceeprom()\r\n");
+    cmd_printf("NFCTestShim::cmd_read_nfc_contents()\r\n");
     cmd_ready(CMDLINE_RETCODE_SUCCESS);
 #endif
 }
@@ -271,11 +271,10 @@ void NFCTestShim::cmd_erase()
   * \param uri This method must free the passed in pointer
   * \return void An ICETEA error code and NFC error is set asyncronously
   */
-void NFCTestShim::cmd_write_long(char *data)
+void NFCTestShim::cmd_write_long(char *text_string)
 {
     MessageBuilder builder(ndef_poster_message);
-
-    strcpy(::long_string, data); //max_ndef - header - overheads
+    strcpy(::long_string, text_string); //max_ndef - header - overheads
     Text text(Text::UTF8, span_from_cstr("en-US"),
               span_from_cstr((const char *)(::long_string)));
 
@@ -290,9 +289,8 @@ void NFCTestShim::cmd_write_long(char *data)
     set_last_nfc_error(NFC_OK);
     cmd_ready(CMDLINE_RETCODE_SUCCESS);
 #endif
-
     cmd_printf("NFCTestShim::write_long() exit\r\n");
-    free(data);
+    free(text_string);
 }
 
 /** \brief Write a URI Use case would be to prompt to install an app from the appstore using the tag

TEST_APPS/device/nfcapp/nfctestshim.h

@@ -28,7 +28,9 @@
 #include "nfc/ndef/common/util.h"
 #include "nfc/NFCDefinitions.h"
 
-
+/**
+ * Test app driver wrapper. This is a base class containing shared EEPROM and Controller test data + logic
+ */
 class NFCTestShim {
 public:
     NFCTestShim(events::EventQueue &queue);
@@ -46,6 +48,7 @@ class NFCTestShim {
     {
         get_conf_nfceeprom();
     };
+    virtual void cmd_get_max_ndef() = 0;
     static void get_last_nfc_error();
     static void set_last_nfc_error(int err);
     static void get_conf_nfceeprom();
@@ -59,8 +62,8 @@ class NFCTestShim {
 
     void cmd_set_smartposter(char *cmdUri);
     void cmd_erase();
-    void cmd_write_long(char *data);
-    void cmd_read_nfceeprom();
+    void cmd_write_long(char *text_string);
+    void cmd_read_nfc_contents();
     void cmd_start_discovery(bool manual = false);
     void cmd_stop_discovery();
     void cmd_configure_rf_protocols(mbed::nfc::nfc_rf_protocols_bitmask_t protocols);
@@ -101,7 +104,6 @@ class NFCTestShim {
     uint8_t _ndef_buffer[MBED_CONF_APP_TEST_NDEF_MSG_MAX];       // driver I/O buffer
     bool _discovery_restart;            // default true, restart discovery loop again on remote disconnect
     events::EventQueue &_queue;
-
 };
 
 // forward declare single instance