docs: Add remote debugging documentation

Signed-off-by: Ajay Bhargav <[email protected]>

Author: ajaybhargav

docs/book/api/system/index.rst

@@ -10,4 +10,5 @@ System
    System Calls <syscall>
    FOTA API <fota>
    Command Processor & Command Line Interface <command_proc>
+   Remote Console/Debugging <rdbg>
    Message Queue <messageq>

docs/book/api/system/rdbg.rst

@@ -0,0 +1,48 @@
+Remote Console/Debugging
+========================
+
+Logicrom provide in-built remote debugging console that runs over a TCP socket.
+
+A remote console session can be initiated by sending *rdbg* command. Device
+opens up a TCP socket to the server and port provided in the command. When
+device is connected to server, it sends a message describing its identity
+in following format
+
+::
+
+    $RDBG,[UID],[IMEI]#[CR][LF]
+
+
+Where UID is device unique ID, and IMEI is module's IMEI.
+
+After the identity string, login prompt is shown. Once logged in, complete
+command line interface is available for device interaction.
+
+
+Example Usage
+--------------
+
+To add remote debug command to system:
+
+.. code-block:: c
+
+    #include <remotedbg.h>
+
+    remote_debug_enable();
+
+Command Line Usage
+^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+
+    # Initate remote debug
+    $ rdbg=<IP/domain>,<port>
+
+    # close remote session
+    $ rdbg=close
+
+
+API Reference
+-------------
+
+.. include:: /inc/remotedbg.inc

include/remotedbg.h

@@ -12,14 +12,21 @@ extern "C" {
 
 /**
  * Initialize and enable Remote debugging
+ * 
  * This will also add rdbg command to firmware
+ * 
  * Usage of rdbg:
+ * 
  * rdbg=[IP],[Port]
+ * 
  * Where IP can be domain name or IP of server to connect
  * Port is server port to connect
  *
- * Once connected, remote server will be greeted with device parameter message in following format
+ * Once connected, remote server will be greeted with device parameter
+ * message in following format
+ * 
  * $RDBG,[Module UID],[IMEI]#[CR][LF]
+ * 
  * and followed by a login prompt.
  */
 void remote_debug_enable(void);