Update Logicrom SDK files

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

Author: ajaybhargav

cores/logicrom/logicromsdk/include/circbuf.h

@@ -28,12 +28,12 @@ int circbuf_delete(int handle);
  * Store one byte to circular buffer
  * @param handle	[in] Handle to circular buffer
  * @param data		[in] Data byte
- * @return			0 on succes, -1 on error
+ * @return			0 on success, -1 on error
  */
 int circbuf_push_byte(int handle, unsigned char data);
 
 /**
- * Store bufferd data to circular buffer
+ * Store buffered data to circular buffer
  * @param handle	[in] Handle to circular buffer
  * @param data		[in] input data buffer
  * @param len		[in] Length of data in buffer
@@ -87,13 +87,13 @@ int circbuf_isempty(int handle);
 
 /**
  * Get available bytes in buffer
- * @param handle	[in] Handle to cirular buffer
+ * @param handle	[in] Handle to circular buffer
  * @return			number of bytes available or negative value on error
  */
 int circbuf_getcount(int handle);
 
 /**
- * Clear and reset curcular buffer
+ * Clear and reset circular buffer
  * @param handle	[in] Handle to circular buffer
  * @return			Always returns 0
  */

cores/logicrom/logicromsdk/include/command.h

@@ -9,7 +9,7 @@
 
 /**
  * Maximum number of allowed arguments
- * including commmand
+ * including command
  */
 #define CMD_MAX_ARGS 16
 

cores/logicrom/logicromsdk/include/filter.h

@@ -1,8 +1,6 @@
 /**
  * @file filter.h
- * @author Ajay Bhargav
  * @brief Filter library to use with ADC
- * 
  */
 
 #ifndef INC_FILTER_H_

cores/logicrom/logicromsdk/include/gpslib.h

@@ -94,7 +94,7 @@ struct gpsdata_t {
 	double lng;			/**< Longitude in degree */
 	float altitude;		/**< Altitude value in meters */
 	double odom;		/**< Odometer value in meteres */
-	float hdop,pdop;	/**< Hdop and Pdop values */
+	float hdop,pdop;	/**< HDOP and PDOP values */
 };
 
 /**

cores/logicrom/logicromsdk/include/hw/bluetooth.h

@@ -84,7 +84,7 @@ int bt_device_init(int mode, const char *name, int use_btcli);
 
 /**
  * Turn on/off bluetooth hardware. Bluetooth is enabled by default when device is initialized.
- * @param on_off		[in] TRUE (1) to turn on or FLASE (0) to turn off
+ * @param on_off		[in] TRUE (1) to turn on or FALSE (0) to turn off
  * @return				For return value see @ref bterr_e
  */
 int bt_device_power(int on_off);

cores/logicrom/logicromsdk/include/hw/gpio.h

@@ -100,7 +100,7 @@ int gpio_setdir(int handle, int dir);
  * GPIO driver provide slow trigger option without debounce support to check and confirm
  * active trigger. On active trigger, callback function is called with state of gpio.
  * Triggers are only possible on gpio configured as inputs.
- * If input level changes after first transition is detected and deounce time,
+ * If input level changes after first transition is detected and debounce time,
  * internal debounce timer is reset for resampling of IO state.
  * @param handle		Handle to gpio object returned by @ref gpio_request
  * @param fn			Callback function of type @ref gpio_callback_f

cores/logicrom/logicromsdk/include/hw/imu_sensor.h

@@ -1,7 +1,7 @@
 /**
  * @file imu_sensor.h
  * @author Ajay Bhargav
- * @brief IMU Sensor fuson library
+ * @brief IMU Sensor fusion library
  * 
  */
 
@@ -73,7 +73,7 @@ typedef void (*imu_eventcb_f)(int event);
 /**
  * @brief IMU configuration structure
  * 
- * accleration threshold values provided are in unit of g
+ * acceleration threshold values provided are in unit of g
  * e.g. a value of 0.5 is 0.5g = 9.8 x 0.5 = 4.9m/s2
  * 
  * when configuration is not provided, below are the default threshold values
@@ -90,10 +90,10 @@ struct imuconf_t {
 	float static_threshold;		   /**< acceleration value below which sensor is considered static */
 	float motion_detect_threshold; /**< acceleration greater than or equal to this generates motion active event */
 	float harsh_accel_threshold;   /**< acceleration threshold for harsh acceleration */
-	float harsh_break_threshold;   /**< deacceleration threshold for harsh breaking event */
+	float harsh_break_threshold;   /**< deceleration threshold for harsh breaking event */
 	float harsh_turn_threshold;	   /**< acceleration threshold while turning */
 	float tilt_angle;			   /**< Tilt threshold angle in degree */
-	float alpha_coff;			   /**< Alpha cofficient, currently not used */
+	float alpha_coff;			   /**< Alpha coefficient, currently not used */
 	int sample_ms;				   /**< Data sample rate in miliseconds. lower the better, 20ms is optimal. */
 };
 
@@ -250,7 +250,7 @@ int imu_get_linearaccel(float *ax, float *ay, float *az);
 
 /**
  * @brief Get acceleration magnitude without gravity component with direction
- * posivity value represents acceleration and negative value represent
+ * positivity value represents acceleration and negative value represent
  * deceleration.
  * 
  * @param force Value of force magnitude in unit of g

cores/logicrom/logicromsdk/include/modem.h

@@ -15,7 +15,7 @@ extern "C"
 #endif
 
 /**
- * Maximum recvieve SMS size
+ * Maximum receieve SMS size
  */
 #define SMS_RECV_MAX_SZ 160
 #define PH_NUM_MAX_SZ	21
@@ -26,7 +26,7 @@ extern "C"
 enum mderror_e
 {
 	MD_SUCCESS = 0,			   /**< success */
-	MD_ERR_FAILED = -1,		   /**< faiure, unknown cause */
+	MD_ERR_FAILED = -1,		   /**< failure, unknown cause */
 	MD_ERR_TIMEOUT = -2,	   /**< operation timeout */
 	MD_ERR_BUSY = -3,		   /**< modem busy */
 	MD_ERR_INVALID_PARAM = -4, /**< Invalid parameter */
@@ -138,7 +138,7 @@ int md_sms_delete(int index, int mode);
  * Set modem CFUN state
  * 
  * @param cfun		[in] CFUN value to set
- * @param rst		[in] reset after setting cfun value
+ * @param rst		[in] reset after setting CFUN value
  * @return 			0 on success, error otherwise (@ref mderror_e)
  */
 int md_cfun_set(int cfun, int rst);
@@ -152,7 +152,7 @@ int md_cfun_get(void);
 /**
  * Initiate a call
  * This is a non-blocking call, If operation is success
- * Call status will be retured as URC response.
+ * Call status will be returned as URC response.
  * 
  * @param phonenum	[in] Number to call
  * @return 			0 on success, error otherwise (@ref mderror_e)

cores/logicrom/logicromsdk/include/net/sockets.h

@@ -137,7 +137,7 @@ int socket_request(int type);
 /**
  * Set socket options
  * @param id		[in] Socket ID
- * @param opts		[in] socket option sturcture see @ref sockopt_t
+ * @param opts		[in] socket option structure see @ref sockopt_t
  * @return			0 on success, negative value on error
  */
 int socket_setopt(int id, struct sockopt_t *opts);

cores/logicrom/logicromsdk/include/os_api.h

@@ -22,14 +22,10 @@ extern "C"
  * @name ev_flags
  * Event flags
  */
-#define EVENT_OP_AND 		0				/** All event flags are required */
-#define EVENT_OP_OR			1				/** Not all event flags are required */
+#define EVENT_OP_AND 		0				/**< All event flags are required */
+#define EVENT_OP_OR			1				/**< Not all event flags are required */
 
-/**
- * @name ev_wait
- */
-#define EVENT_WAIT_SUSPEND	0xFFFFFFFF		/** Suspend task until requested flags are set */
-#define EVENT_NO_WAIT		0				/** Do not wait */
+#define OS_WAIT_FOREVER	(-1U)				/**< Wait indefinitely */
 
 /**
  * Sleep Type
@@ -54,7 +50,7 @@ struct osmsg_t {
 	uint32_t message;	/**< Message ID */
 	uint32_t param1;	/**< First parameter */
 	uint32_t param2;	/**< Second parameter */
-	int source_taskid;	/**< Filled automatically by os_get_message() */
+	int source_taskid;	/**< Filled automatically by @ref os_message_get() */
 };
 
 /**
@@ -82,7 +78,7 @@ void sys_setsleep_timeout(uint32_t ms);
 /**
  * Enter sleep mode
  * @note only available on NBIoT Platforms
- * @param type		[in] Type of sleep @a sleeptype_e
+ * @param type		[in] Type of sleep @ref sleeptype_e
  */
 void sys_setsleep(int type);
 #endif
@@ -91,105 +87,111 @@ void sys_setsleep(int type);
  * Task sleep API
  * @param ms		[in] time in milliseconds
  */
-void os_sleep(unsigned int ms);
+void os_task_sleep(unsigned int ms);
 
 /**
  * Get message from task external queue
  * @param msg		[in] Pointer to OS message structure @ref osmsg_t
  * @return			0 on success, negative value on error
  */
-int os_get_message(struct osmsg_t *msg);
+int os_message_get(struct osmsg_t *msg);
 
 /**
  * Send message to a task external queue, Maximum number of messages are 30
- * OS will raise an assert if more than 30 messages are sent to task queue.
+ * @note on GSM Platform, an assert is raised if more than 30 messages are sent to task queue.
  * @param dest_taskid	[in] Destination task id
  * @param message		[in] Message ID
  * @param param1		[in] Parameter 1
  * @param param2		[in] Parameter 2
  * @return				0 on success, negative value on error
  */
-int os_send_message(int dest_taskid, uint32_t message, uint32_t param1, uint32_t param2);
+int os_message_send(int dest_taskid, uint32_t message, uint32_t param1, uint32_t param2);
 
 /**
  * Create a mutex
  * Mutex created once cannot be destroyed.
- * @param name	[in] Name for mutex (cannot be null)
  * @return		Mutex ID
  */
-uint32_t os_create_mutex(const char *name);
+uint32_t os_mutex_create(void);
 
 /**
  * Take a mutex. If mutex is not available, Task will be suspended until mutex is available.
- * @param mutex		[in] Mutex ID created by os_create_mutex()
+ * @param mutex		[in] Mutex ID created by @ref os_mutex_create()
+ * @return			0 on success, negative value on error
+ */
+int os_mutex_take(uint32_t mutex);
+
+/**
+ * Try to take a mutex. This API is similar to @ref os_mutex_take() with a optional timeout
+ * @param mutex		[in] Mutex ID created by @ref os_mutex_create()
+ * @param timeout	[in] duration in ms to wait, @ref OS_WAIT_FOREVER for indefinite wait, 0 to return immediately
  * @return			0 on success, negative value on error
  */
-int os_take_mutex(uint32_t mutex);
+int os_mutex_trytake(uint32_t mutex, uint32_t timeout);
 
 /**
  * Release a mutex. Once a mutex is released, OS does not yield on waiting task. Task switch happens when executing task is suspended
  * by sleep or waiting on external queue message.
- * @param mutex		[in] Mutex ID created by os_create_mutex()
+ * @param mutex		[in] Mutex ID created by @ref os_mutex_create()
  * @return			0 on success, negative value on error
  */
-int os_give_mutex(uint32_t mutex);
+int os_mutex_give(uint32_t mutex);
 
 /**
  * Create a semaphore
- * @param name		[in] Name of semaphore (cannot be null), for debugging only.
  * @param val		[in] Initial value of semaphore
  * @return			Semaphore ID
  */
-uint32_t os_create_semaphore(const char *name, int val);
+uint32_t os_semaphore_create(int val);
 
 /**
  * Take a semaphore. When semaphore is not available and wait is requested, task will be suspended until semaphore is available
- * @param sem		[in] Semaphore ID created by os_create_semaphore()
- * @param wait		[in] TRUE if wait for semaphore to be available, FALSE to return immediately
+ * @param sem		[in] Semaphore ID created by @ref os_semaphore_create()
+ * @param timeout	[in] duration in ms to timeout, @ref OS_WAIT_FOREVER for indefinite timeout, 0 to return immediately\n
+ * 					On GSM platforms, when timeout is non zero API blocks until semaphore is acquired
  * @return			0 on success, negative value on error
  */
-int os_take_semaphore(uint32_t sem, int wait);
+int os_semaphore_take(uint32_t sem, int timeout);
 
 /**
  * Give a semaphore.
- * @param sem		[in] Semaphore ID created by os_create_semaphore()
+ * @param sem		[in] Semaphore ID created by @ref os_semaphore_create()
  * @return			0 on success, negative value on error
  */
-int os_give_semaphore(uint32_t sem);
+int os_semaphore_give(uint32_t sem);
 
 /**
  * Create event group. Event group has 32 flags represented by each bit of a 32-bit word.
- * @param name		[in] Name of event group (cannot be null).
  * @return			event group ID
  */
-uint32_t os_create_eventgroup(const char *name);
+uint32_t os_eventgroup_create(void);
 
 /**
  * Set event in event group
  * @param egid			[in] Event group ID
  * @param event_flags	[in] Event flags to set. Each bit represents an event flags
  * @return
  */
-int os_eg_setevent(uint32_t egid, uint32_t event_flags);
+int os_eventgroup_setevent(uint32_t egid, uint32_t event_flags);
 
 /**
  * Wait for event flag to set
  * @param egid			[in] Event group id
- * @param event_flags	[in] Requeted flags
+ * @param event_flags	[in] Requested flags
  * @return				0 on success, negative value on error
  */
-int os_eg_waitevent(uint32_t egid, uint32_t event_flags);
+int os_eventgroup_waitevent(uint32_t egid, uint32_t event_flags);
 
 /**
  * Extended function for event flag wait
  * @param egid			[in] Event group ID
  * @param req_flags		[in] Requested flags
  * @param op			[in] Operation type ev_flags
  * @param out_flags		[out] Actual event flags available
- * @param timeout		[in] Timeout in milliseconds or one of the ev_wait flags
+ * @param timeout		[in] Timeout in milliseconds or @ref OS_WAIT_FOREVER to wait until an event is raised
  * @return				0 on success, negative value on error
  */
-int os_eg_waiteventex(uint32_t egid, uint32_t req_flags, int op, uint32_t *out_flags, uint32_t timeout);
+int os_eventgroup_waiteventex(uint32_t egid, uint32_t req_flags, int op, uint32_t *out_flags, uint32_t timeout);
 
 /**
  * Get available stack size of running task
@@ -201,7 +203,7 @@ uint32_t os_task_getavailstack(void);
  * Get task id of running task
  * @return		Returns task id
  */
-uint32_t os_get_currtaskid(void);
+uint32_t os_task_getid(void);
 
 /**
  * Create a new OS task, Maximum 10 tasks can be created
@@ -210,7 +212,7 @@ uint32_t os_get_currtaskid(void);
  * @param suspend		[in] TRUE will suspend the task on creation, FALSE otherwise. Suspended task can be started later by calling os_start_task()
  * @return				On success task ID is returned, -1 on error.
  */
-int os_create_task(os_taskfn_f fn, void *arg, int suspend);
+int os_task_create(os_taskfn_f fn, void *arg, int suspend);
 
 #if defined(SOC_RDA8910) || defined(PLATFORM_BC20) || defined(_DOXYGEN_)
 /**
@@ -222,10 +224,10 @@ int os_create_task(os_taskfn_f fn, void *arg, int suspend);
  * @param suspend		[in] TRUE will suspend the task on creation, FALSE otherwise. Suspended task can be started later by calling os_start_task()
  * @return				On success task ID is returned, -1 on error.
  */
-int os_create_taskex(os_taskfn_f fn, uint32_t stack, void *arg, int suspend);
+int os_task_create_ex(os_taskfn_f fn, uint32_t stack, void *arg, int suspend);
 
 /**
- * Start a task created by os_create_task()/os_create_taskex()
+ * Start a task created by @ref os_task_create() /@ref os_task_create_ex()
  * @note only available on NBIoT Platforms
  * @param taskid		[in] Task ID
  * @return				0 on success, negative value on error
@@ -240,17 +242,17 @@ uint64_t os_get_tickms(void);
 
 /**
  * Get OS tick/uptime in microseconds
- * @return tick counter in microseonds
+ * @return tick counter in microseconds
  */
 uint64_t os_get_tickus(void);
 #endif
 
 /**
- * Start a task created by os_create_task()
+ * Start a task created by @ref os_task_create()
  * @param taskid		[in] Task ID
  * @return				0 on success, negative value on error
  */
-int os_start_task(int taskid);
+int os_task_start(int taskid);
 
 /**
  * Enter critical section
@@ -260,7 +262,7 @@ uint32_t os_enter_critical(void);
 
 /**
  * Exit critical section
- * @param flags			[in] IRQ flags from os_enter_critical()
+ * @param flags			[in] IRQ flags from @ref os_enter_critical()
  */
 void os_exit_critical(uint32_t flags);