lby/lk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[lib][console] move the command block private stuff into lib/console

Browse Source 
Pull some of the machinery of the lib/console stuff into a private
header that is only pulled in when lib/console is built.
This commit is contained in:
Travis Geiselbrecht
2020-05-17 15:43:00 -07:00
parent 77f5dac525
commit 30a334288f
3 changed files with 56 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
lib/console/include/lib/console.h
View File

@@ -14,6 +14,7 @@
* this file.
*/
#include <lk/console_cmd.h>
#include <lib/console/cmd.h>
/* external api */
int console_init(void);

53
lib/console/include/lib/console/cmd.h Normal file
View File

@@ -0,0 +1,53 @@
/*
* Copyright (c) 2008-2009 Travis Geiselbrecht
*
* Use of this source code is governed by a MIT-style
* license that can be found in the LICENSE file or at
* https://opensource.org/licenses/MIT
*/
#pragma once
#include <stdbool.h>
#include <stddef.h>
#include <sys/types.h>
/* included from top level lk/console_cmd.h when lib/console is built.
* Provides definitions for how to register a command block to be picked up by
* the lib/console machinery.
*/
/* an individual command */
typedef struct {
const char *cmd_str;
const char *help_str;
const console_cmd cmd_callback;
uint8_t availability_mask;
} cmd;
/* a block of commands to register */
typedef struct _cmd_block {
struct _cmd_block *next;
size_t count;
const cmd *list;
} cmd_block;
#define STATIC_COMMAND_START static const cmd _cmd_list[] = {
#define STATIC_COMMAND_END(name) }; cmd_block _cmd_block_##name \
__ALIGNED(sizeof(void *)) __SECTION("commands") = \
{ NULL, sizeof(_cmd_list) / sizeof(_cmd_list[0]), _cmd_list }
/* same as above but with a suffixed name to make the list unique within the file */
#define STATIC_COMMAND_START_NAMED(name) static const cmd _cmd_list_##name[] = {
#define STATIC_COMMAND_END_NAMED(name) }; cmd_block _cmd_block_##name \
__ALIGNED(sizeof(void *)) __SECTION("commands") = \
{ NULL, sizeof(_cmd_list_##name) / sizeof(_cmd_list_##name[0]), _cmd_list_##name }
#define STATIC_COMMAND(command_str, help_str, func) \
{ command_str, help_str, func, CMD_AVAIL_NORMAL },
#define STATIC_COMMAND_MASKED(command_str, help_str, func, availability_mask) \
{ command_str, help_str, func, availability_mask },

31
top/include/lk/console_cmd.h
View File

@@ -27,39 +27,14 @@ typedef int (*console_cmd)(int argc, const cmd_args *argv);
#define CMD_AVAIL_PANIC (0x1 << 1)
#define CMD_AVAIL_ALWAYS (CMD_AVAIL_NORMAL | CMD_AVAIL_PANIC)
/* a block of commands to register */
typedef struct {
const char *cmd_str;
const char *help_str;
const console_cmd cmd_callback;
uint8_t availability_mask;
} cmd;
typedef struct _cmd_block {
struct _cmd_block *next;
size_t count;
const cmd *list;
} cmd_block;
/* Register a static block of commands at init time when lib/console is
* paret of the build. Otherwise stub out these definitions so that they do
* not get included.
*/
#if WITH_LIB_CONSOLE
#define STATIC_COMMAND_START static const cmd _cmd_list[] = {
#define STATIC_COMMAND_END(name) }; cmd_block _cmd_block_##name __ALIGNED(sizeof(void *)) __SECTION("commands") = \
{ NULL, sizeof(_cmd_list) / sizeof(_cmd_list[0]), _cmd_list }
/* same as above but with a suffixed name to make the list unique within the file */
#define STATIC_COMMAND_START_NAMED(name) static const cmd _cmd_list_##name[] = {
#define STATIC_COMMAND_END_NAMED(name) }; cmd_block _cmd_block_##name __ALIGNED(sizeof(void *)) __SECTION("commands") = \
{ NULL, sizeof(_cmd_list_##name) / sizeof(_cmd_list_##name[0]), _cmd_list_##name }
#define STATIC_COMMAND(command_str, help_str, func) { command_str, help_str, func, CMD_AVAIL_NORMAL },
#define STATIC_COMMAND_MASKED(command_str, help_str, func, availability_mask) { command_str, help_str, func, availability_mask },
/* pull the equivalent strctures and macros out of lib/console's headers */
#include <lib/console/cmd.h>
#else
@@ -73,5 +48,3 @@ typedef struct _cmd_block {
#define STATIC_COMMAND_MASKED(command_str, help_str, func, availability_mask)
#endif
#define COMMAND_BLOCK_INIT_ITEM(cmd_block_ptr, cmd_ptr) {(cmd_block_ptr)->next = NULL; (cmd_block_ptr)->count = 1; (cmd_block_ptr)->list = cmd_ptr;}