update include/platform_hal.h

CHANGELOG.md

@@ -4,25 +4,42 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
-#### [1.1.0](https://github.com/rdkcentral/rdkb-platform-hal/compare/1.0.1...1.1.0)
+#### [1.2.1](https://github.com/rdkcentral/rdkb-halif-platform/compare/1.2.0...1.2.1)
 
-- Extended the DHCP defines to support extended options. [`#6`](https://github.com/rdkcentral/rdkb-platform-hal/pull/6)
-- RDKB-52640 : updating platform_hal.h file for Unify Wan Manager [`eeae9ca`](https://github.com/rdkcentral/rdkb-platform-hal/commit/eeae9cafb27a2e6b0321c8767aa7c6a22c265e97)
-- Merge tag '1.0.1' into develop [`15f94af`](https://github.com/rdkcentral/rdkb-platform-hal/commit/15f94af6a22709f33ee941c9a661e03f9066db30)
+- Rdkb test release kirkstone [`#15`](https://github.com/rdkcentral/rdkb-halif-platform/pull/15)
+- Update platform_hal.h [`9a372ee`](https://github.com/rdkcentral/rdkb-halif-platform/commit/9a372eec00f6eef9dfe83306cf27d20ed1063ce1)
+- RDKBDEV-2326 Updating platform_hal.h file to add API for Eco Mode status [`042bd1c`](https://github.com/rdkcentral/rdkb-halif-platform/commit/042bd1c03d3e2540de9a50307afb701335ac9846)
+- RDKBDEV-2733: Update platform_hal.h with PPP username and password APIs. [`4110627`](https://github.com/rdkcentral/rdkb-halif-platform/commit/41106271f311b56dd9b4adfb9c4beea4fb036577)
 
-#### [1.0.1](https://github.com/rdkcentral/rdkb-platform-hal/compare/1.0.0...1.0.1)
+#### [1.2.0](https://github.com/rdkcentral/rdkb-halif-platform/compare/1.1.0...1.2.0)
+
+> 28 December 2023
+
+- Merge pull request #7 from biju-vi/main [`47e8c9d`](https://github.com/rdkcentral/rdkb-halif-platform/commit/47e8c9d9e2e126d563b4e2d74a590e6526391685)
+- RDKBDEV-2326 Updating platform_hal.h file to add API for Eco Mode status [`b886d3f`](https://github.com/rdkcentral/rdkb-halif-platform/commit/b886d3f15bf827fc37f318879fd42851e77d5e27)
+
+#### [1.1.0](https://github.com/rdkcentral/rdkb-halif-platform/compare/1.0.1...1.1.0)
+
+> 20 November 2023
+
+- Extended the DHCP defines to support extended options. [`#6`](https://github.com/rdkcentral/rdkb-halif-platform/pull/6)
+- RDKB-52640 : updating platform_hal.h file for Unify Wan Manager [`eeae9ca`](https://github.com/rdkcentral/rdkb-halif-platform/commit/eeae9cafb27a2e6b0321c8767aa7c6a22c265e97)
+- bumped CHANGELOG.md [`a1b3cf9`](https://github.com/rdkcentral/rdkb-halif-platform/commit/a1b3cf9f49f3f8e42e2d024f82384c3d8af157ce)
+- Merge tag '1.0.1' into develop [`15f94af`](https://github.com/rdkcentral/rdkb-halif-platform/commit/15f94af6a22709f33ee941c9a661e03f9066db30)
+
+#### [1.0.1](https://github.com/rdkcentral/rdkb-halif-platform/compare/1.0.0...1.0.1)
 
 > 13 November 2023
 
-- Removed .vscode dir and added to gitignore [`077d4b6`](https://github.com/rdkcentral/rdkb-platform-hal/commit/077d4b6b6da66fbf70eec58b6ec62fff6af8475b)
-- Bumped CHANGELOG.md - 1.0.1 [`ffbe5f1`](https://github.com/rdkcentral/rdkb-platform-hal/commit/ffbe5f1f01cbaa45b76e9d5ad070c14c0e220b8d)
-- Merge tag '1.0.0' into develop [`c156aa3`](https://github.com/rdkcentral/rdkb-platform-hal/commit/c156aa35db694726f75c01b01d7b439f7130597a)
+- Removed .vscode dir and added to gitignore [`077d4b6`](https://github.com/rdkcentral/rdkb-halif-platform/commit/077d4b6b6da66fbf70eec58b6ec62fff6af8475b)
+- Bumped CHANGELOG.md - 1.0.1 [`ffbe5f1`](https://github.com/rdkcentral/rdkb-halif-platform/commit/ffbe5f1f01cbaa45b76e9d5ad070c14c0e220b8d)
+- Merge tag '1.0.0' into develop [`c156aa3`](https://github.com/rdkcentral/rdkb-halif-platform/commit/c156aa35db694726f75c01b01d7b439f7130597a)
 
 #### 1.0.0
 
 > 8 November 2023
 
-- Feature/RDKB-52300 [`#3`](https://github.com/rdkcentral/rdkb-platform-hal/pull/3)
-- RDKB-50692 : Platform HAL Header file on new rdkb-platform-hal [`76539f1`](https://github.com/rdkcentral/rdkb-platform-hal/commit/76539f1a1cb03fa2f720aa8f7b4214606204f47c)
-- updating last review code changes [`833d36b`](https://github.com/rdkcentral/rdkb-platform-hal/commit/833d36bcb7d99f458971dce0ef1ccef4c2e7c7f9)
-- review updated, check #TODO [`551edcd`](https://github.com/rdkcentral/rdkb-platform-hal/commit/551edcdffa317854f94d2deac2056be6e1808c4f)
+- Feature/RDKB-52300 [`#3`](https://github.com/rdkcentral/rdkb-halif-platform/pull/3)
+- RDKB-50692 : Platform HAL Header file on new rdkb-platform-hal [`76539f1`](https://github.com/rdkcentral/rdkb-halif-platform/commit/76539f1a1cb03fa2f720aa8f7b4214606204f47c)
+- updating last review code changes [`833d36b`](https://github.com/rdkcentral/rdkb-halif-platform/commit/833d36bcb7d99f458971dce0ef1ccef4c2e7c7f9)
+- review updated, check #TODO [`551edcd`](https://github.com/rdkcentral/rdkb-halif-platform/commit/551edcdffa317854f94d2deac2056be6e1808c4f)

include/platform_hal.h

@@ -1397,7 +1397,34 @@ INTF_STATS, *PINTF_STATS;
 */
 INT platform_hal_GetInterfaceStats(const char *ifname,PINTF_STATS pIntfStats);
 
+/**
+ * @brief Get the PPP username.
+ * 
+ * This function retrieves the PPP username and stores it in the buffer 
+ * pointed to by `pUserName`.
+ *
+ * @param[out] pUserName Pointer to a buffer to store the PPP username.
+ * @param[in] maxSize The maximum size of the `pUserName` buffer.
+ *
+ * @returns The status of the operation.
+ *      - RETURN_OK if the username is successfully retrieved.
+ *      - RETURN_ERR if an error is encountered during the operation.
+ */
 INT platform_hal_GetPppUserName(CHAR* pUserName, ULONG maxSize);
+
+/**
+ * @brief Get the PPP password.
+ * 
+ * This function retrieves the PPP password and stores it in the buffer 
+ * pointed to by `pPassword`.
+ *
+ * @param[out] pPassword Pointer to a buffer to store the PPP password.
+ * @param[in] maxSize The maximum size of the `pPassword` buffer.
+ *
+ * @returns The status of the operation.
+ *      - RETURN_OK if the password is successfully retrieved.
+ *      - RETURN_ERR if an error is encountered during the operation.
+ */
 INT platform_hal_GetPppPassword(CHAR* pPassword, ULONG maxSize);
 
 #ifdef __cplusplus