osu: Add board parameter getters

Getter for board parameters using hal apis are added.
 * hal_device_board_get_boot_mode
 * hal_device_board_get_current_partition
 * hal_device_board_get_partition_ab_cloned
 * hal_device_board_get_partition_status
 * hal_device_board_get_upgrade_progress_status
 * hal_device_board_get_upgrade_state
 * hal_device_board_get_upgrade_type

Change-Id: I8f0fb10487df649887d76036f52e3e75743f1033
Signed-off-by: SangYoun Kwak <sy.kwak@samsung.com>

diff --git a/tools/osu/CMakeLists.txt b/tools/osu/CMakeLists.txt
index da2727c7318cb31bba5e9e53980e4a719a2c66b2..6790f7a6cd305a7cb2f81ccc853b83f3b5e5810e 100644 (file)
--- a/tools/osu/CMakeLists.txt
+++ b/tools/osu/CMakeLists.txt
@@ -15,7 +15,7 @@ ENDFOREACH(flag)
 
 INCLUDE_DIRECTORIES(. ${CMAKE_SOURCE_DIR}/include)
 
-FILE(GLOB_RECURSE SRCS osu.c resize.c update.c)
+FILE(GLOB_RECURSE SRCS osu.c resize.c update.c board-params-getter.c)
 ADD_EXECUTABLE(${OUTPUT_BIN_NAME} ${SRCS})
 SET(CMAKE_EXE_LINKER_FLAGS "-Wl,--as-needed -pie")
 TARGET_LINK_LIBRARIES(${OUTPUT_BIN_NAME} ${REQUIRED_PKGS_LDFLAGS} update-control)

diff --git a/tools/osu/board-params-getter.c b/tools/osu/board-params-getter.c
new file mode 100644 (file)
index 0000000..4fb98f9
--- /dev/null
+++ b/tools/osu/board-params-getter.c
@@ -0,0 +1,250 @@
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include <assert.h>
+#include <errno.h>
+
+#include <hal/hal-device-board.h>
+
+#define BOARD_PARAM_PARAMS_LEN 2
+
+struct board_param_getter {
+       char *param_name;
+       char *description;
+       int (*getter)(char **params, size_t params_len, char *buffer, size_t buffer_size);
+};
+
+static int boot_mode_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(buffer != NULL);
+
+       return hal_device_board_get_boot_mode(buffer, buffer_size);
+}
+
+static int current_partition_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(buffer != NULL);
+       assert(buffer_size >= 2);
+
+       int ret = 0;
+       char partition_ab;
+
+       ret = hal_device_board_get_current_partition(&partition_ab);
+       if (ret != 0)
+               return ret;
+
+       buffer[0] = partition_ab;
+       buffer[1] = '\0';
+
+       return 0;
+}
+
+static int partition_ab_cloned_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(buffer != NULL);
+       assert(buffer_size >= 2);
+
+       int ret = 0;
+       int cloned = 0;
+
+       ret = hal_device_board_get_partition_ab_cloned(&cloned);
+       if (ret != 0)
+               return ret;
+
+       ret = snprintf(buffer, buffer_size, "%d", !!cloned);
+       if (ret < 0)
+               return ret;
+
+       return 0;
+}
+
+static int partition_status_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(params != NULL);
+       assert(buffer != NULL);
+
+       char partition_ab = '\0';
+
+       if (params_len != 1)
+               return -EINVAL;
+
+       if (params[0] == NULL)
+               return -EINVAL;
+
+       partition_ab = params[0][0];
+       if (partition_ab != 'a' && partition_ab != 'b')
+               return -EINVAL;
+
+       return hal_device_board_get_partition_status(partition_ab, buffer, buffer_size);
+}
+
+static int upgrade_progress_status_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(buffer != NULL);
+
+       int ret = 0;
+       int progress_status = 0;
+
+       ret = hal_device_board_get_upgrade_progress_status(&progress_status);
+       if (ret < 0)
+               return ret;
+
+       ret = snprintf(buffer, buffer_size, "%d", progress_status);
+       if (ret < 0)
+               return ret;
+
+       return 0;
+}
+
+static int upgrade_state_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(buffer != NULL);
+
+       return hal_device_board_get_upgrade_state(buffer, buffer_size);
+}
+
+static int upgrade_type_getter(char **params, size_t params_len, char *buffer, size_t buffer_size)
+{
+       assert(buffer != NULL);
+
+       return hal_device_board_get_upgrade_type(buffer, buffer_size);
+}
+
+static struct board_param_getter getters[] = {
+       {
+               .param_name = "boot-mode",
+               .description = "Get boot mode.",
+               .getter = boot_mode_getter
+       }, {
+               .param_name = "current-partition",
+               .description = "Get current partition (a or b)",
+               .getter = current_partition_getter
+       }, {
+               .param_name = "partition-ab-cloned",
+               .description = "Get partition is cloned or not: 1 is cloned, 0 is not cloned.",
+               .getter = partition_ab_cloned_getter
+       }, {
+               .param_name = "partition-status",
+               .description = "Get partition status. 1 param is required: 'a' or 'b'.",
+               .getter = partition_status_getter
+       }, {
+               .param_name = "upgrade-progress-status",
+               .description = "Get current upgrade progress status: -1 ~ 100",
+               .getter = upgrade_progress_status_getter
+       }, {
+               .param_name = "upgrade-state",
+               .description = "Get current upgrade state.",
+               .getter = upgrade_state_getter
+       }, {
+               .param_name = "upgrade-type",
+               .description = "Get current upgrade type: offline or online",
+               .getter = upgrade_type_getter
+       }, {
+               /* sentinel for this array */
+               .param_name = NULL,
+               .description = NULL,
+               .getter = NULL
+       },
+};
+
+static int get_board_param_getter(const char *param_name, struct board_param_getter **board_param_getter)
+{
+       size_t param_name_len = strlen(param_name);
+
+       for (int i = 0; getters[i].param_name != NULL; ++i) {
+               if (strncmp(getters[i].param_name, param_name, param_name_len + 1) == 0) {
+                       *board_param_getter = &getters[i];
+                       return 0;
+               }
+       }
+
+       return -1;
+}
+
+static void print_board_param_getters(void)
+{
+       printf("Available getter board params:\n");
+       for (int i = 0; getters[i].param_name != NULL; ++i) {
+               if (getters[i].getter == NULL)
+                       continue;
+               printf("    %s: %s\n", getters[i].param_name, getters[i].description);
+       }
+
+       printf("\n"
+               " * Parameters should be provided separated with ','.\n"
+               " * e.g. \"partition-status,a\"\n");
+}
+
+static size_t split_params(char **params, size_t params_len, const char *delim, char *params_str)
+{
+       assert(params_len > 0);
+
+       char *strtok_saveptr = NULL;
+       size_t params_index = 0;
+
+       params[0] = strtok_r(params_str, delim, &strtok_saveptr);
+       if (params[0] == NULL)
+               return 0;
+
+       for (params_index = 1; params_index < params_len; ++params_index) {
+               params[params_index] = strtok_r(NULL, delim, &strtok_saveptr);
+               if (params[params_index] == NULL)
+                       break;
+       }
+
+       return params_index;
+}
+
+int do_get_board_param(const char *params_str)
+{
+       int ret = 0;
+       char *params_str_dup = NULL;
+       struct board_param_getter *board_param_getter = NULL;
+       char result_buffer[1024] = { 0, };
+
+       char *params[BOARD_PARAM_PARAMS_LEN] = { NULL, };
+       size_t params_len = BOARD_PARAM_PARAMS_LEN;
+       char *param_name = NULL;
+
+       params_str_dup = strdup(params_str);
+       if (params_str_dup == NULL) {
+               printf("Failed to allocate memory for params.\n");
+               return 1;
+       }
+
+       params_len = split_params(params, params_len, ",", params_str_dup);
+       if (params_len < 1) {
+               printf("Invalid parameter.\n");
+               ret = -1;
+               goto release_and_exit;
+       }
+       param_name = params[0];
+
+       if (strncmp(param_name, "help", sizeof("help")) == 0) {
+               print_board_param_getters();
+               ret = 0;
+               goto release_and_exit;
+       }
+
+       ret = get_board_param_getter(param_name, &board_param_getter);
+       if (ret != 0) {
+               printf("Invalid board param: %s\n", params_str);
+               print_board_param_getters();
+               goto release_and_exit;
+       }
+
+       ret = (board_param_getter->getter)(params + 1, params_len - 1, result_buffer, sizeof(result_buffer));
+       if (ret != 0) {
+               printf("Failed to get board param %s: %d\n", param_name, ret);
+               printf("%s: %s\n", param_name, board_param_getter->description);
+               goto release_and_exit;
+       }
+
+       ret = 0;
+       printf("%s\n", result_buffer);
+
+release_and_exit:
+       free(params_str_dup);
+
+       return ret;
+}

diff --git a/tools/osu/board-params-getter.h b/tools/osu/board-params-getter.h
new file mode 100644 (file)
index 0000000..194528c
--- /dev/null
+++ b/tools/osu/board-params-getter.h
@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2024 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+int do_get_board_param(const char *param_name);

diff --git a/tools/osu/board-params.h b/tools/osu/board-params.h
new file mode 100644 (file)
index 0000000..9bd7d78
--- /dev/null
+++ b/tools/osu/board-params.h
@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2024 Samsung Electronics Co., Ltd All Rights Reserved
+ *
+ * Licensed under the Apache License, Version 2.0 (the License);
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an AS IS BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "board-params-getter.h"

diff --git a/tools/osu/osu.c b/tools/osu/osu.c
index 58563df9fec0101062dd38d2a81c863e960a4acd..6ff9ab5eb0af5fbb5cef408774262ee1139da7c1 100644 (file)
--- a/tools/osu/osu.c
+++ b/tools/osu/osu.c
@@ -25,6 +25,7 @@
 
 #include "resize.h"
 #include "update.h"
+#include "board-params.h"
 
 
 struct arguments {
@@ -32,6 +33,8 @@ struct arguments {
        bool resize;
        bool update;
        bool online;
+       bool get_board_param;
+       char *board_param;
 };
 
 static void print_help(char*);
@@ -45,12 +48,15 @@ static int parse_args(int argc, char **argv, struct arguments *args)
        args->resize = false;
        args->update = false;
        args->online = false;
+       args->get_board_param = false;
+       args->board_param = NULL;
 
        struct option long_options[] = {
                {"resize", no_argument, NULL, 'r'},
                {"update", no_argument, NULL, 'u'},
                {"offline-update", no_argument, NULL, 'f'},
                {"online-update", no_argument, NULL, 'n'},
+               {"get-board-param", required_argument, NULL, 'g'},
                {"help", no_argument, NULL, 'h'},
                {}
        };
@@ -72,6 +78,11 @@ static int parse_args(int argc, char **argv, struct arguments *args)
                                args->online = true;
                                return 0;
                        }
+                       case 'g': {
+                               args->get_board_param = true;
+                               args->board_param = optarg;
+                               return 0;
+                       }
                        case 'h': {
                                args->help = true;
                                return 0;
@@ -95,12 +106,15 @@ static void print_help(char *my_name)
        printf("Usage:\n"
                "    %s [--help|--resize|--update]\n\n"
                "Possible arguments:\n"
-               "  --help             Print this help\n"
-               "  --update           Trigger the OS Upgrade (Offline Upgrade)\n"
-               "  --offline-update   Trigger the OS Offline Upgrade\n"
-               "  --online-update    Trigger the OS Online Upgrade\n"
-               "  --resize           Run resize2fs on the rootfs partition.\n"
-               "             After that, performing the OS Upgrade will be impossible.\n\n" ,my_name);
+               "  --help                                       Print this help\n"
+               "  --update                                     Trigger the OS Upgrade (Offline Upgrade)\n"
+               "  --offline-update                             Trigger the OS Offline Upgrade\n"
+               "  --online-update                              Trigger the OS Online Upgrade\n"
+               "  --resize                                     Run resize2fs on the rootfs partition.\n"
+               "                                               After that, performing the OS Upgrade will be impossible.\n"
+               "  --get-board-param <param name>[,<param>...]  Print value of a board param\n"
+               "                                               Use <param name> as 'help' for details.\n"
+               "\n" ,my_name);
 }
 
 int main(int argc, char **argv)
@@ -122,6 +136,9 @@ int main(int argc, char **argv)
        if (args.update)
                return do_update(args.online);
 
+       if (args.get_board_param)
+               return do_get_board_param(args.board_param);
+
        print_help(argv[0]);
 
        return 1;