litex

// This file is Copyright (c) 2020 Franck Jullien <franck.jullien@gmail.com>

// SPDX-License-Identifier: BSD-Source-Code

#ifndef __COMMAND_H__
#define __COMMAND_H__

#define MAX_PARAM	8

#define SYSTEM_CMDS		0
#define BOOT_CMDS		1
#define MEM_CMDS		2
#define SPIFLASH_CMDS	3
#define I2C_CMDS		4
#define LITEDRAM_CMDS	5
#define LITEETH_CMDS	6
#define LITESDCARD_CMDS	7
#define LITESATA_CMDS	8
#define NB_OF_GROUPS	9

typedef void (*cmd_handler)(int nb_params, char **params);

struct command_struct {
	void (*func)(int nb_params, char **params);
	const char *name;
	const char *help;
	int group;
	const char *usage;
	unsigned char min_args;
	unsigned char max_args;
};

extern const struct command_struct *const __bios_cmd_start[];
extern const struct command_struct *const __bios_cmd_end[];

#ifdef BIOS_CONSOLE_DISABLE
	#define define_command_args(cmd_name, handler, help_txt, usage_txt, min_count, max_count, group_id)
#else
	#define define_command_args(cmd_name, handler, help_txt, usage_txt, min_count, max_count, group_id) \
		const struct command_struct s_##cmd_name = {					     \
			.func = (cmd_handler)handler,					     \
			.name = #cmd_name,						     \
			.help = help_txt,						     \
			.group = group_id,						     \
			.usage = usage_txt, \
			.min_args = min_count, \
			.max_args = max_count, \
		};									     \
		const struct command_struct *const __bios_cmd_##cmd_name __attribute__((__used__)) \
		__attribute__((__section__(".bios_cmd"))) = &s_##cmd_name

	const struct command_struct *command_dispatcher(char *command, int nb_params, char **params);

	#endif

/* Preserve source compatibility for target-specific command registrations. */
#define define_command(cmd_name, handler, help_txt, group_id) \
	define_command_args(cmd_name, handler, help_txt, 0, 0, MAX_PARAM, group_id)
#endif