lib: custom: simplify naming scheme

Improve the naming scheme of the custom library.

Signed-off-by: Gerard Marull-Paretas <[email protected]>

Author: gmarull

include/app/custom_lib/custom_lib.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2021, Legrand North America, LLC.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef APP_LIB_CUSTOM_H_
+#define APP_LIB_CUSTOM_H_
+
+/**
+ * @defgroup lib_custom Custom library
+ * @ingroup lib
+ * @{
+ *
+ * @brief An example of a custom out-of-tree library.
+ *
+ * This library illustrates how create custom out-of-tree libraries. Splitting
+ * code in libraries enables code reuse and modularity, also easing testing.
+ */
+
+/**
+ * @brief Return @p val if non-zero, or Kconfig-controlled default.
+ *
+ * Function returns the provided value if non-zero, or a Kconfig-controlled
+ * default value if the parameter is zero. This trivial function is provided in
+ * order to have a library interface example that is trivial to test.
+ *
+ * @param val Value to return if non-zero
+ *
+ * @retval val if @p val is non-zero
+ * @retval CONFIG_CUSTOM_GET_VALUE_DEFAULT if @p val is zero
+ */
+int custom_get_value(int val);
+
+/** @} */
+
+#endif /* APP_LIB_CUSTOM_H_ */

include/app/lib/custom.h

@@ -1,3 +1,3 @@
 # SPDX-License-Identifier: Apache-2.0
 
-add_subdirectory_ifdef(CONFIG_CUSTOM_LIB custom_lib)
+add_subdirectory_ifdef(CONFIG_CUSTOM custom)

lib/CMakeLists.txt

@@ -1,8 +1,8 @@
 # Copyright (c) 2021 Legrand North America, LLC.
 # SPDX-License-Identifier: Apache-2.0
 
-menu "Libraries"
+menu "Custom libraries"
 
-rsource "custom_lib/Kconfig"
+rsource "custom/Kconfig"
 
 endmenu

lib/Kconfig

@@ -2,4 +2,4 @@
 # SPDX-License-Identifier: Apache-2.0
 
 zephyr_library()
-zephyr_library_sources(custom_lib.c)
+zephyr_library_sources(custom.c)

lib/custom_lib/CMakeLists.txt renamed to lib/custom/CMakeLists.txt

@@ -0,0 +1,19 @@
+# Copyright (c) 2021, Legrand North America, LLC.
+# SPDX-License-Identifier: Apache-2.0
+
+config CUSTOM
+	bool "Support for custom library"
+	help
+	  This option enables the 'custom' library
+
+config CUSTOM_GET_VALUE_DEFAULT
+	int "custom_get_value() default return value"
+	depends on CUSTOM
+	default 0
+	help
+	  This option primarily exists as an example of a library Kconfig
+	  setting.
+
+	  This option specifies the value for custom_get_value() to return
+	  when the input parameter is zero. (Otherwise the function returns the
+	  input parameter value.)

lib/custom/Kconfig

@@ -0,0 +1,12 @@
+/*
+ * Copyright (c) 2021, Legrand North America, LLC.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <app/lib/custom.h>
+
+int custom_get_value(int val)
+{
+	return (val != 0) ? val : CONFIG_CUSTOM_GET_VALUE_DEFAULT;
+}

lib/custom/custom.c

@@ -3,7 +3,6 @@
 
 cmake_minimum_required(VERSION 3.20.0)
 find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
-project(custom_lib)
+project(app_lib_custom_test)
 
-FILE(GLOB app_sources src/*.c)
-target_sources(app PRIVATE ${app_sources})
+target_sources(app PRIVATE src/main.c)