include: fix typo in header files

ajaybhargav · ajaybhargav · commit 374da343624f · 2022-02-22T19:16:59.000+05:30
Signed-off-by: Ajay Bhargav &lt;contact@rickeyworld.info&gt;
diff --git a/include/circbuf.h b/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
  */
diff --git a/include/command.h b/include/command.h
@@ -9,7 +9,7 @@
 
 /**
  * Maximum number of allowed arguments
- * including commmand
+ * including command
  */
 #define CMD_MAX_ARGS 16
 
diff --git a/include/filter.h b/include/filter.h
@@ -1,8 +1,6 @@
 /**
  * @file filter.h
- * @author Ajay Bhargav
  * @brief Filter library to use with ADC
- * 
  */
 
 #ifndef INC_FILTER_H_
diff --git a/include/gpslib.h b/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 */
 };
 
 /**
diff --git a/include/hw/bluetooth.h b/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);
diff --git a/include/hw/gpio.h b/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
diff --git a/include/hw/imu_sensor.h b/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
diff --git a/include/modem.h b/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)
diff --git a/include/net/sockets.h b/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);
diff --git a/include/plat/def_pwm.h b/include/plat/def_pwm.h
@@ -18,7 +18,7 @@ enum pwm1_prd_e {
 };
 
 /**
- * PWM Channel 1 - Fixed Ontime/Duty cycle in milliseconds
+ * PWM Channel 1 - Fixed On-time/Duty cycle in milliseconds
  * @note: Only for Platform with RDA8910 SoC
  */
 enum pwm1_duty_e {
diff --git a/include/private/linker_list.h b/include/private/linker_list.h
@@ -79,7 +79,7 @@
 /* _ll_entry_get_array(array_name)
 
    is used to declare an access variable for the array
-   this macro should be used at flie-scope, as ll_entry_get_array() is invalid there
+   this macro should be used at file-scope, as ll_entry_get_array() is invalid there
 
    example usage:
      _ll_entry_get_array(int, numbers, numberArray);
@@ -141,7 +141,7 @@
 		size; \
 	})
 
-/* ll_entry_get_array_lenght(type, array_name)
+/* ll_entry_get_array_length(type, array_name)
 
    is used to determine the number of elements in an array
 
diff --git a/include/proto/modbus.h b/include/proto/modbus.h
@@ -133,7 +133,7 @@ int mb_init(const char *com, int mode, mb_dirctl func);
 /**
  * Configure MODBUS Parameters
  * @param baud		[in] Baudrate value as in termios.h e.g. B9600
- * @param com_para	[in] Communication parameter data bits, partiy and stopbit in ascii format e.g. "8N1", "8E2"
+ * @param com_para	[in] Communication parameter data bits, parity and stopbit in ascii format e.g. "8N1", "8E2"
  * 					Data bits: 8, 7, 6, 5 (not supported on all platforms)
  * 					Parity: N - None, E - Even, O - Odd Parity
  * 					Stop Bits: 1 or 2
diff --git a/include/remotedbg.h b/include/remotedbg.h
@@ -19,7 +19,7 @@ extern "C" {
  * Port is server port to connect
  *
  * Once connected, remote server will be greeted with device parameter message in following format
- * $RDBG,[Serial Number],[IMEI]#[CR][LF]
+ * $RDBG,[Module UID],[IMEI]#[CR][LF]
  * and login prompt will be shown for remote console
  */
 void remote_debug_enable(void);
diff --git a/include/ril/ril.h b/include/ril/ril.h
@@ -62,7 +62,7 @@ enum networkstate_e {
 enum cfunstate_e {
 	CFUN_STATE_0 = 0,/**< Minimal functionality */
 	CFUN_STATE_1 = 1,/**< Full functionality */
-	CFUN_STATE_4 = 4 /**< Disable phone from both transmit ting and receiv ing RF signals */
+	CFUN_STATE_4 = 4 /**< Disable phone from both transmit ting and receive ing RF signals */
 };
 
 /**
@@ -104,8 +104,8 @@ enum sysurc_e {
 	URC_NEW_SMS_IND,            /**< Indication for new short message, parameter value as index of incoming SMS */
 	URC_MODULE_VOLTAGE_IND,     /**< Indication for abnormal voltage of module supply power, parameter value as @ref vbattind_e */
 	URC_ALARM_RING_IND,		    /**< Indication for clock alarm. */
-	URC_STKPCI_RSP_IND,			/**< Indication for un-handled STKPCI responses, Only when QSTK is enabled, Parameter value is incoming +STKPCI response as null terminated string */
-	URC_RRC_STATUS_IND,			/**< 4GLTE & NBIoT RRC Status update */
+	URC_STKPCI_RSP_IND,			/**< Indication for un-handled STKPCI responses, Only when SIM Toolkit is enabled, Parameter value is incoming +STKPCI response as null terminated string */
+	URC_RRC_STATUS_IND,			/**< 4G LTE & NBIoT RRC Status update */
 	URC_SYS_END = 100,
 	/*
 	 * System URC definition end
@@ -192,7 +192,7 @@ extern ril_recvcb_f cb_rcvCoreData;
  * @param arg			[in] User argument passed to callback function
  * @param timeout		[in] Timeout for command execution
  * @param wait			[in] Wait for RIL to be available (TRUE) or not (FALSE).
- * 							 If wait is false, function returns immideatly if RIL is
+ * 							 If wait is false, function returns immediately if RIL is
  * 							 unavailable.
  * 							 If true function will wait for RIL availability until
  * 							 timeout occurs.
diff --git a/include/storage.h b/include/storage.h
@@ -106,7 +106,7 @@ int storage_delete(int part, int count);
  * Get storage status
  *
  * @param part			[in] Partition index, starting from 0
- * @return				TRUE if offline is pending, FALSE if not data is avilable
+ * @return				TRUE if offline is pending, FALSE if not data is available
  */
 int storage_available(int part);
 
diff --git a/include/sys/socket.h b/include/sys/socket.h
@@ -147,7 +147,7 @@ extern "C" {
 #endif
 
 /**
- * Create an endpoint for communnication
+ * Create an endpoint for communication
  * @param domain			[in] Communication domain, Must be AF_INET
  * @param type				[in] Socket type @ref SOCK_STREAM or @ref SOCK_DGRAM
  * @param protocol			[in] Protocol type, 0 for auto-select
diff --git a/include/sys/termios.h b/include/sys/termios.h
@@ -153,9 +153,9 @@
 #define TCSAFLUSH  2                /**< Change attributes when output has drained; also flush pending input. */
 
 /* Line Control constants for use with tcflush(): */
-#define TCIFLUSH    1               /**< Flush pending input. Flush untransmitted output. */
-#define TCIOFLUSH   2               /**< Flush both pending input and untransmitted output. */
-#define TCOFLUSH    3               /**< Flush untransmitted output. */
+#define TCIFLUSH    1               /**< Flush pending input. Flush un-transmitted output. */
+#define TCIOFLUSH   2               /**< Flush both pending input and un-transmitted output. */
+#define TCOFLUSH    3               /**< Flush un-transmitted output. */
 
 /* constants for use with tcflow(): */
 #define TCIOFF      0               /**< Transmit a STOP character, intended to suspend input data. */
