rename

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
zephyrproject-rtos · Jan 28, 2024 · de85a26 · de85a26
1 parent 7c96260
commit de85a26
Show file tree

Hide file tree

Showing 17 changed files with 49 additions and 55 deletions.
diff --git a/doc/hardware/peripherals/display/index.rst b/doc/hardware/peripherals/display/index.rst
@@ -25,7 +25,7 @@ BBC micro:bit Display
 
 .. doxygengroup:: mb_display
 
-Monochrome Character Framebuffer
+Compact Framebuffer
 ================================
 
-.. doxygengroup:: monochrome_character_framebuffer
+.. doxygengroup:: compact_framebuffer
diff --git a/include/zephyr/display/cfb.h b/include/zephyr/display/cfb.h
@@ -7,7 +7,7 @@
 
 /**
  * @file
- * @brief Public Monochrome Character Framebuffer API
+ * @brief Public Compact Framebuffer subsystem API
  */
 
 #ifndef __CFB_H__
@@ -23,8 +23,8 @@ extern "C" {
 #endif
 
 /**
- * @brief Public Monochrome Character Framebuffer API
- * @defgroup monochrome_character_framebuffer Monochrome Character Framebuffer
+ * @brief Public Compact Framebuffer subsystem API
+ * @defgroup compact_framebuffer Compact Framebuffer
  * @ingroup utilities
  * @{
  */

diff --git a/samples/boards/reel_board/mesh_badge/prj.conf b/samples/boards/reel_board/mesh_badge/prj.conf
@@ -60,7 +60,7 @@ CONFIG_SPI_ASYNC=y
 CONFIG_HEAP_MEM_POOL_SIZE=16384
 CONFIG_DISPLAY=y
 
-CONFIG_CHARACTER_FRAMEBUFFER=y
+CONFIG_CFB=y
 
 CONFIG_BT_SETTINGS=y
 CONFIG_FLASH=y

diff --git a/samples/subsys/display/cfb/README.rst b/samples/subsys/display/cfb/README.rst
@@ -1,20 +1,20 @@
-.. zephyr:code-sample:: character-frame-buffer
-   :name: Character frame buffer
-   :relevant-api: monochrome_character_framebuffer
+.. zephyr:code-sample:: compact-frame-buffer
+   :name: Compact frame buffer
+   :relevant-api: compactframebuffer
 
-   Display character strings using the Character Frame Buffer (CFB).
+   Display character strings using the Compact Frame Buffer (CFB) subsystem.
 
 Overview
 ********
 
-This sample displays character strings using the Character Frame Buffer
-(CFB) subsystem framework.
+This sample displays character strings using the Compact Frame Buffer
+(CFB) subsystem.
 
 Requirements
 ************
 
-This sample requires a supported board and CFB-supporting
-display, such as the :ref:`reel_board`.
+This sample requires a board that have a display,
+such as the :ref:`reel_board`.
 
 Building and Running
 ********************

diff --git a/samples/subsys/display/cfb/prj.conf b/samples/subsys/display/cfb/prj.conf
@@ -7,7 +7,7 @@ CONFIG_DISPLAY=y
 CONFIG_LOG=y
 
 CONFIG_CFB_LOG_LEVEL_DBG=y
-CONFIG_CHARACTER_FRAMEBUFFER=y
+CONFIG_CFB=y
 
 CONFIG_CFB_SAMPLE_TRANSFER_BUFFER_SIZE=4096
 CONFIG_CFB_SAMPLE_COMMAND_BUFFER_SIZE=1024
diff --git a/samples/subsys/display/cfb/sample.yaml b/samples/subsys/display/cfb/sample.yaml
@@ -2,7 +2,7 @@ common:
   harness: display
   tags: display
 sample:
-  description: Character framebuffer test
+  description: Compact framebuffer test
   name: cfb sample
 tests:
   sample.display.cfb.ssd1306:

diff --git a/samples/subsys/display/cfb_custom_font/README.rst b/samples/subsys/display/cfb_custom_font/README.rst
@@ -1,12 +1,12 @@
 .. zephyr:code-sample:: cfb-custom-fonts
    :name: Custom fonts
-   :relevant-api: monochrome_character_framebuffer
+   :relevant-api: compact_framebuffer
 
    Generate and use a custom font.
 
 Overview
 ********
-A simple example showing how to generate Character Framebuffer (CFB)
+A simple example showing how to generate Compact Framebuffer (CFB)
 font headers automatically at build time.
 
 This example generates a font with font elements for 6 sided dice from
@@ -25,12 +25,7 @@ directory:
 - :file:`prj.conf`
   Generic config file, normally you should use this.
 
-- :file:`boards/reel_board.conf`
-  This overlay config enables support for SSD16XX display controller
-  on the reel_board.
-
-
-Example building for the reel_board with SSD16XX display support:
+Example building for the reel_board:
 
 .. zephyr-app-commands::
    :zephyr-app: samples/subsys/display/cfb_custom_font

diff --git a/samples/subsys/display/cfb_custom_font/prj.conf b/samples/subsys/display/cfb_custom_font/prj.conf
@@ -2,7 +2,7 @@ CONFIG_HEAP_MEM_POOL_SIZE=16384
 
 CONFIG_DISPLAY=y
 
-CONFIG_CHARACTER_FRAMEBUFFER=y
-CONFIG_CHARACTER_FRAMEBUFFER_USE_DEFAULT_FONTS=n
+CONFIG_CFB=y
+CONFIG_CFB_USE_DEFAULT_FONTS=n
 CONFIG_CFB_CUSTOM_FONT_SAMPLE_TRANSFER_BUFFER_SIZE=4096
 CONFIG_CFB_CUSTOM_FONT_SAMPLE_COMMAND_BUFFER_SIZE=1024
diff --git a/samples/subsys/display/cfb_custom_font/sample.yaml b/samples/subsys/display/cfb_custom_font/sample.yaml
@@ -2,7 +2,7 @@ common:
   harness: display
   tags: display
 sample:
-  description: Custom character framebuffer font example
+  description: Compact framebuffer font example
   name: cfb custom font sample
 tests:
   sample.display.cfb_custom_font.ssd16xx:

diff --git a/samples/subsys/display/cfb_shell/README.rst b/samples/subsys/display/cfb_shell/README.rst
@@ -1,13 +1,13 @@
 .. zephyr:code-sample:: cfb-shell-sample
-   :name: Character Framebuffer shell module
-   :relevant-api: monochrome_character_framebuffer
+   :name: Compact Framebuffer shell module
+   :relevant-api: compact_framebuffer
 
-   Use the CFB shell module to interact with a monochrome display.
+   Use the CFB shell module to interact with a display.
 
 Overview
 ********
-This is a simple shell module that exercises displays using the Character
-Framebuffer subsystem.
+This is a simple shell module that exercises displays using the Compact
+Framebuffer(CFB) subsystem.
 
 Building and Running
 ********************
@@ -25,7 +25,7 @@ Shell Module Command Help
 
 .. code-block:: console
 
-         cfb - Character Framebuffer shell commands
+         cfb - Compact Framebuffer shell commands
          Options:
                  -h, --help  :Show command help.
          Subcommands:

diff --git a/samples/subsys/display/cfb_shell/prj.conf b/samples/subsys/display/cfb_shell/prj.conf
@@ -1,6 +1,6 @@
 CONFIG_BOOT_BANNER=n
 CONFIG_HEAP_MEM_POOL_SIZE=16384
 CONFIG_DISPLAY=y
-CONFIG_CHARACTER_FRAMEBUFFER=y
+CONFIG_CFB=y
 CONFIG_SHELL=y
-CONFIG_CHARACTER_FRAMEBUFFER_SHELL=y
+CONFIG_CFB_SHELL=y
diff --git a/samples/subsys/display/cfb_shell/sample.yaml b/samples/subsys/display/cfb_shell/sample.yaml
@@ -2,7 +2,7 @@ common:
   harness: display
   tags: display
 sample:
-  description: Character framebuffer shell test
+  description: Compact framebuffer shell test
   name: cfb shell sample
 tests:
   sample.display.cfb_shell.ssd1306:

diff --git a/scripts/build/gen_cfb_font_header.py b/scripts/build/gen_cfb_font_header.py
@@ -204,7 +204,7 @@ def parse_args():
     """Parse arguments"""
     global args
     parser = argparse.ArgumentParser(
-        description="Character Frame Buffer (CFB) font header file generator",
+        description="Compact Framebuffer (CFB) font header file generator",
         formatter_class=argparse.RawDescriptionHelpFormatter, allow_abbrev=False)
 
     parser.add_argument(

diff --git a/subsys/fb/CMakeLists.txt b/subsys/fb/CMakeLists.txt
@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
-zephyr_sources_ifdef(CONFIG_CHARACTER_FRAMEBUFFER cfb.c)
-zephyr_sources_ifdef(CONFIG_CHARACTER_FRAMEBUFFER_USE_DEFAULT_FONTS cfb_fonts.c)
-zephyr_sources_ifdef(CONFIG_CHARACTER_FRAMEBUFFER_SHELL cfb_shell.c)
+zephyr_sources_ifdef(CONFIG_CFB cfb.c)
+zephyr_sources_ifdef(CONFIG_CFB_USE_DEFAULT_FONTS cfb_fonts.c)
+zephyr_sources_ifdef(CONFIG_CFB_SHELL cfb_shell.c)
 
-zephyr_linker_sources_ifdef(CONFIG_CHARACTER_FRAMEBUFFER DATA_SECTIONS check_cfb_fonts.ld)
+zephyr_linker_sources_ifdef(CONFIG_CFB DATA_SECTIONS check_cfb_fonts.ld)
diff --git a/subsys/fb/Kconfig b/subsys/fb/Kconfig
@@ -3,21 +3,21 @@
 # Copyright (c) 2018 Phytec Messtechnik GmbH
 # SPDX-License-Identifier: Apache-2.0
 
-menuconfig CHARACTER_FRAMEBUFFER
-	bool "Character framebuffer for dot matrix displays"
+menuconfig CFB
+	bool "Compact framebuffer subsystem"
 	help
-	  Character framebuffer for dot matrix displays.
+	  Compact graphics subsystem for systems with tiny memory.
 
-if CHARACTER_FRAMEBUFFER
+if CFB
 
-config CHARACTER_FRAMEBUFFER_USE_DEFAULT_FONTS
+config CFB_USE_DEFAULT_FONTS
 	bool "Use default fonts"
 	default y
 	help
 	  Use default fonts.
 
-config CHARACTER_FRAMEBUFFER_SHELL
-	bool "Character Framebuffer shell"
+config CFB_SHELL
+	bool "Compact Framebuffer shell"
 	depends on SHELL
 	help
 	  Activate shell module that provides Framebuffer commands to the
@@ -27,4 +27,4 @@ module = CFB
 module-str = cfb
 source "subsys/logging/Kconfig.template.log_config"
 
-endif # CHARACTER_FRAMEBUFFER
+endif # CFB
diff --git a/subsys/fb/cfb_shell.c b/subsys/fb/cfb_shell.c
@@ -1,7 +1,7 @@
 /** @file
- * @brief Monochrome Character Framebuffer shell module
+ * @brief Compact Framebuffer shell module
  *
- * Provide some Character Framebuffer shell commands that can be useful for
+ * Provide some Compact Framebuffer shell commands that can be useful for
  * testing.
  */
 
@@ -610,5 +610,4 @@ SHELL_STATIC_SUBCMD_SET_CREATE(cfb_cmds,
 	SHELL_SUBCMD_SET_END
 );
 
-SHELL_CMD_REGISTER(cfb, &cfb_cmds, "Character Framebuffer shell commands",
-		   NULL);
+SHELL_CMD_REGISTER(cfb, &cfb_cmds, "Compact Framebuffer shell commands", NULL);
diff --git a/tests/subsys/display/cfb/basic/prj.conf b/tests/subsys/display/cfb/basic/prj.conf
@@ -3,8 +3,8 @@
 
 CONFIG_ZTEST=y
 CONFIG_DISPLAY=y
-CONFIG_CHARACTER_FRAMEBUFFER=y
-CONFIG_CHARACTER_FRAMEBUFFER_USE_DEFAULT_FONTS=n
+CONFIG_CFB=y
+CONFIG_CFB_USE_DEFAULT_FONTS=n
 
 CONFIG_HEAP_MEM_POOL_SIZE=16384
 CONFIG_TEST_CFB_TRANSFER_BUF_SIZE=307200