[IOTCELL-282] Code cleanup/simplification and rules

Baseline is changed to use a single set of data structures that simplifies the
code in the LoRaWANStack and Mac layer. We are now following certian rules for naming
data structures.

- All structures visible outside their domain are prefixed as 'lorawan_'
- All mac structures are prefixed as 'loramac_'
- All subsystem or module strucutures carry their name in prefix, like 'mcps_'

PHY layer still have legacy camel case data structures which will be entertained
later while we will be simplifying PHY layer.
Test cases are also updated with the new data structure naming conventions.

One major difference from the previous baseline is the removal of static buffer
from mcps indication. And we do not copy data from stack buffer to rx_msg buffer.
This saves at least 512 bytes.

It may look like now that if we have received something but the user have not read
from the buffer, then the buffer will be overwritten and we will lose previous frame.
Yes, we will. But the same will happen even if we would have copied the buffer into rx_msg
because then the rx_msg gets overwritten. So we decide to abandon copying the buffer at
multiple locations. We inform the user about reception, if the user doesn't read and
the data gets overwritten, then so be it.

Author: Hasnain Virk

features/lorawan/LoRaWANInterface.cpp

@@ -42,16 +42,16 @@ LoRaWANInterface::~LoRaWANInterface()
 {
 }
 
-lora_mac_status_t LoRaWANInterface::initialize(EventQueue *queue)
+lorawan_status_t LoRaWANInterface::initialize(EventQueue *queue)
 {
     if(!queue) {
-        return LORA_MAC_STATUS_PARAMETER_INVALID;
+        return LORAWAN_STATUS_PARAMETER_INVALID;
     }
 
     return stk_obj().initialize_mac_layer(queue);
 }
 
-lora_mac_status_t LoRaWANInterface::connect()
+lorawan_status_t LoRaWANInterface::connect()
 {
     // connection attempt without parameters.
     // System tries to look for configuration in mbed_lib.json that can be
@@ -96,28 +96,28 @@ lora_mac_status_t LoRaWANInterface::connect()
     }
 }
 
-lora_mac_status_t LoRaWANInterface::connect(const lorawan_connect_t &connect)
+lorawan_status_t LoRaWANInterface::connect(const lorawan_connect_t &connect)
 {
-    lora_mac_status_t mac_status;
+    lorawan_status_t mac_status;
 
     if (connect.connect_type == LORAWAN_CONNECTION_OTAA) {
         mac_status = stk_obj().join_request_by_otaa(connect);
     } else if (connect.connect_type == LORAWAN_CONNECTION_ABP) {
         mac_status = stk_obj().activation_by_personalization(connect);
     } else {
-        return LORA_MAC_STATUS_PARAMETER_INVALID;
+        return LORAWAN_STATUS_PARAMETER_INVALID;
     }
 
     return mac_status;
 }
 
-lora_mac_status_t LoRaWANInterface::disconnect()
+lorawan_status_t LoRaWANInterface::disconnect()
 {
     stk_obj().shutdown();
-    return LORA_MAC_STATUS_OK;
+    return LORAWAN_STATUS_OK;
 }
 
-lora_mac_status_t LoRaWANInterface::add_link_check_request()
+lorawan_status_t LoRaWANInterface::add_link_check_request()
 {
     _link_check_requested = true;
     return stk_obj().set_link_check_request();
@@ -128,42 +128,42 @@ void LoRaWANInterface::remove_link_check_request()
     _link_check_requested = false;
 }
 
-lora_mac_status_t LoRaWANInterface::set_datarate(uint8_t data_rate)
+lorawan_status_t LoRaWANInterface::set_datarate(uint8_t data_rate)
 {
     return stk_obj().set_channel_data_rate(data_rate);
 }
 
-lora_mac_status_t LoRaWANInterface::set_confirmed_msg_retries(uint8_t count)
+lorawan_status_t LoRaWANInterface::set_confirmed_msg_retries(uint8_t count)
 {
     return stk_obj().set_confirmed_msg_retry(count);
 }
 
-lora_mac_status_t LoRaWANInterface::enable_adaptive_datarate()
+lorawan_status_t LoRaWANInterface::enable_adaptive_datarate()
 {
     return stk_obj().enable_adaptive_datarate(true);
 }
 
-lora_mac_status_t LoRaWANInterface::disable_adaptive_datarate()
+lorawan_status_t LoRaWANInterface::disable_adaptive_datarate()
 {
     return stk_obj().enable_adaptive_datarate(false);
 }
 
-lora_mac_status_t LoRaWANInterface::set_channel_plan(const lora_channelplan_t &channel_plan)
+lorawan_status_t LoRaWANInterface::set_channel_plan(const lorawan_channelplan_t &channel_plan)
 {
     return stk_obj().add_channels(channel_plan);
 }
 
-lora_mac_status_t LoRaWANInterface::get_channel_plan(lora_channelplan_t &channel_plan)
+lorawan_status_t LoRaWANInterface::get_channel_plan(lorawan_channelplan_t &channel_plan)
 {
     return stk_obj().get_enabled_channels(channel_plan);
 }
 
-lora_mac_status_t LoRaWANInterface::remove_channel(uint8_t id)
+lorawan_status_t LoRaWANInterface::remove_channel(uint8_t id)
 {
     return stk_obj().remove_a_channel(id);
 }
 
-lora_mac_status_t LoRaWANInterface::remove_channel_plan()
+lorawan_status_t LoRaWANInterface::remove_channel_plan()
 {
     return stk_obj().drop_channel_list();
 }
@@ -180,7 +180,7 @@ int16_t LoRaWANInterface::send(uint8_t port, const uint8_t* data,
     if (data) {
         return stk_obj().handle_tx(port, data, length, flags);
     } else {
-        return LORA_MAC_STATUS_PARAMETER_INVALID;
+        return LORAWAN_STATUS_PARAMETER_INVALID;
     }
 }
 
@@ -190,19 +190,18 @@ int16_t LoRaWANInterface::receive(uint8_t port, uint8_t* data, uint16_t length,
     if (data && length > 0) {
         return stk_obj().handle_rx(port, data, length, flags);
     } else {
-        return LORA_MAC_STATUS_PARAMETER_INVALID;
+        return LORAWAN_STATUS_PARAMETER_INVALID;
     }
 }
 
-lora_mac_status_t LoRaWANInterface::add_app_callbacks(lorawan_app_callbacks_t *callbacks)
+lorawan_status_t LoRaWANInterface::add_app_callbacks(lorawan_app_callbacks_t *callbacks)
   {
 
      if (!callbacks || !callbacks->events) {
          // Event Callback is mandatory
-         return LORA_MAC_STATUS_PARAMETER_INVALID;
+         return LORAWAN_STATUS_PARAMETER_INVALID;
      }
 
      stk_obj().set_lora_callbacks(callbacks);
-
-     return LORA_MAC_STATUS_OK;
+     return LORAWAN_STATUS_OK;
   }

features/lorawan/LoRaWANInterface.h

@@ -44,15 +44,15 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      * @return         0 on success, a negative error code on failure.
      */
-    virtual lora_mac_status_t initialize(events::EventQueue *ev_queue) ;
+    virtual lorawan_status_t initialize(events::EventQueue *ev_queue) ;
 
     /** Connect OTAA or ABP using Mbed-OS config system
      *
      * Connect by Over The Air Activation or Activation By Personalization.
      * You need to configure the connection properly via the Mbed OS configuration
      * system.
      *
-     * When connecting via OTAA, the return code for success (LORA_MAC_STATUS_CONNECT_IN_PROGRESS) is negative.
+     * When connecting via OTAA, the return code for success (LORAWAN_STATUS_CONNECT_IN_PROGRESS) is negative.
      * However, this is not a real error. It tells you that the connection is in progress and you will
      * be notified of the completion via an event. By default, after the Join Accept message
      * is received, base stations may provide the node with a CF-List that replaces
@@ -78,17 +78,17 @@ class LoRaWANInterface: public LoRaWANBase {
      * is important, at least for ABP. That's why we try to restore frame counters from
      * session information after a disconnection.
      *
-     * @return         LORA_MAC_STATUS_OK or LORA_MAC_STATUS_CONNECT_IN_PROGRESS
+     * @return         LORAWAN_STATUS_OK or LORAWAN_STATUS_CONNECT_IN_PROGRESS
      *                 on success, or a negative error code on failure.
      */
-    virtual lora_mac_status_t connect();
+    virtual lorawan_status_t connect();
 
     /** Connect OTAA or ABP with parameters
      *
      * All connection parameters are chosen by the user and provided in the
      * data structure passed down.
      *
-     * When connecting via OTAA, the return code for success (LORA_MAC_STATUS_CONNECT_IN_PROGRESS) is negative.
+     * When connecting via OTAA, the return code for success (LORAWAN_STATUS_CONNECT_IN_PROGRESS) is negative.
      * However, this is not a real error. It tells you that connection is in progress and you will
      * be notified of completion via an event. By default, after Join Accept message
      * is received, base stations may provide the node with a CF-List which replaces
@@ -118,17 +118,17 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      * @param connect  Options for an end device connection to the gateway.
      *
-     * @return        LORA_MAC_STATUS_OK or LORA_MAC_STATUS_CONNECT_IN_PROGRESS,
+     * @return        LORAWAN_STATUS_OK or LORAWAN_STATUS_CONNECT_IN_PROGRESS,
      *                a negative error code on failure.
      */
-    virtual lora_mac_status_t connect(const lorawan_connect_t &connect);
+    virtual lorawan_status_t connect(const lorawan_connect_t &connect);
 
     /** Disconnect the current session.
      *
-     * @return         LORA_MAC_STATUS_OK on success, a negative error code on
+     * @return         LORAWAN_STATUS_OK on success, a negative error code on
      *                 failure.
      */
-    virtual lora_mac_status_t disconnect();
+    virtual lorawan_status_t disconnect();
 
     /** Validate the connectivity with the network.
      *
@@ -145,7 +145,7 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      * This API is usable only when the 'link_check_resp' callback is set by
      * the application. See add_lora_app_callbacks API. If the above mentioned
-     * callback is not set, a LORA_MAC_STATUS_PARAMETER_INVALID error is thrown.
+     * callback is not set, a LORAWAN_STATUS_PARAMETER_INVALID error is thrown.
      *
      * First parameter to callback function is the demodulation margin and
      * the second parameter is the number of gateways that successfully received
@@ -155,11 +155,11 @@ class LoRaWANInterface: public LoRaWANBase {
      * transmission, until/unless application explicitly turns it off using
      * remove_link_check_request() API.
      *
-     * @return          LORA_MAC_STATUS_OK on successfully queuing a request, or
+     * @return          LORAWAN_STATUS_OK on successfully queuing a request, or
      *                  a negative error code on failure.
      *
      */
-    virtual lora_mac_status_t add_link_check_request();
+    virtual lorawan_status_t add_link_check_request();
 
     /** Removes link check request sticky MAC command.
      *
@@ -176,28 +176,28 @@ class LoRaWANInterface: public LoRaWANBase {
      * @param data_rate   The intended data rate, for example DR_0 or DR_1.
      *                    Please note, that the macro DR_* can mean different
      *                    things in different regions.
-     * @return            LORA_MAC_STATUS_OK if everything goes well, otherwise
+     * @return            LORAWAN_STATUS_OK if everything goes well, otherwise
      *                    a negative error code.
      */
-    virtual lora_mac_status_t set_datarate(uint8_t data_rate);
+    virtual lorawan_status_t set_datarate(uint8_t data_rate);
 
     /** Enables adaptive data rate (ADR).
      *
      * The underlying LoRaPHY and LoRaMac layers handle the data rate automatically
      * for the user, based upon the radio conditions (network congestion).
      *
-     * @return          LORA_MAC_STATUS_OK or negative error code otherwise.
+     * @return          LORAWAN_STATUS_OK or negative error code otherwise.
      */
-    virtual lora_mac_status_t enable_adaptive_datarate();
+    virtual lorawan_status_t enable_adaptive_datarate();
 
     /** Disables adaptive data rate.
      *
      * When adaptive data rate (ADR) is disabled, you can either set a certain
      * data rate or the MAC layer selects a default value.
      *
-     * @return          LORA_MAC_STATUS_OK or negative error code otherwise.
+     * @return          LORAWAN_STATUS_OK or negative error code otherwise.
      */
-    virtual lora_mac_status_t disable_adaptive_datarate();
+    virtual lorawan_status_t disable_adaptive_datarate();
 
     /** Sets up the retry counter for confirmed messages.
      *
@@ -212,9 +212,9 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      * @param count     The number of retries for confirmed messages.
      *
-     * @return          LORA_MAC_STATUS_OK or a negative error code.
+     * @return          LORAWAN_STATUS_OK or a negative error code.
      */
-    virtual lora_mac_status_t set_confirmed_msg_retries(uint8_t count);
+    virtual lorawan_status_t set_confirmed_msg_retries(uint8_t count);
 
     /** Sets the channel plan.
      *
@@ -240,10 +240,10 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      * @param channel_plan      The channel plan to set.
      *
-     * @return                  LORA_MAC_STATUS_OK on success, a negative error
+     * @return                  LORAWAN_STATUS_OK on success, a negative error
      *                          code on failure.
      */
-    virtual lora_mac_status_t set_channel_plan(const lora_channelplan_t &channel_plan);
+    virtual lorawan_status_t set_channel_plan(const lorawan_channelplan_t &channel_plan);
 
     /** Gets the channel plans from the LoRa stack.
      *
@@ -254,31 +254,31 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      * @param  channel_plan     The current channel plan information.
      *
-     * @return                  LORA_MAC_STATUS_OK on success, a negative error
+     * @return                  LORAWAN_STATUS_OK on success, a negative error
      *                          code on failure.
      */
-    virtual lora_mac_status_t get_channel_plan(lora_channelplan_t &channel_plan);
+    virtual lorawan_status_t get_channel_plan(lorawan_channelplan_t &channel_plan);
 
     /** Removes an active channel plan.
      *
      * You cannot remove default channels (the channels the base stations are listening to).
      * When a plan is abolished, only the non-default channels are removed.
      *
-     * @return                  LORA_MAC_STATUS_OK on success, a negative error
+     * @return                  LORAWAN_STATUS_OK on success, a negative error
      *                          code on failure.
      */
-    virtual lora_mac_status_t remove_channel_plan();
+    virtual lorawan_status_t remove_channel_plan();
 
     /** Removes a single channel.
      *
      * You cannot remove default channels (the channels the base stations are listening to).
      *
      * @param    index          The channel index.
      *
-     * @return                  LORA_MAC_STATUS_OK on success, a negative error
+     * @return                  LORAWAN_STATUS_OK on success, a negative error
      *                          code on failure.
      */
-    virtual lora_mac_status_t remove_channel(uint8_t index);
+    virtual lorawan_status_t remove_channel(uint8_t index);
 
     /** Send message to gateway
      *
@@ -311,7 +311,7 @@ class LoRaWANInterface: public LoRaWANBase {
      *
      *
      * @return                  The number of bytes sent, or
-     *                          LORA_MAC_STATUS_WOULD_BLOCK if another TX is
+     *                          LORAWAN_STATUS_WOULD_BLOCK if another TX is
      *                          ongoing, or a negative error code on failure.
      */
     virtual int16_t send(uint8_t port, const uint8_t* data, uint16_t length,
@@ -352,7 +352,7 @@ class LoRaWANInterface: public LoRaWANBase {
      * @return                  It could be one of these:
      *                             i)   0 if there is nothing else to read.
      *                             ii)  Number of bytes written to user buffer.
-     *                             iii) LORA_MAC_STATUS_WOULD_BLOCK if there is
+     *                             iii) LORAWAN_STATUS_WOULD_BLOCK if there is
      *                                  nothing available to read at the moment.
      *                             iv)  A negative error code on failure.
      */
@@ -427,7 +427,7 @@ class LoRaWANInterface: public LoRaWANBase {
        * @param callbacks         A pointer to the structure containing application
        *                          callbacks.
        */
-    virtual lora_mac_status_t add_app_callbacks(lorawan_app_callbacks_t *callbacks);
+    virtual lorawan_status_t add_app_callbacks(lorawan_app_callbacks_t *callbacks);
 
 private:
     bool _link_check_requested;