IO Command Handlers

Functions
static ERR_te	io_cmd_w_handler (uint32_t argc, char **argv)
	CLI handler for the "w" command. Writes a logic level to a named IO pin.
static ERR_te	io_cmd_r_handler (uint32_t argc, char **argv)
	CLI handler for the "r" command. Reads and logs the logic level of a named IO pin.
static ERR_te	io_cmd_info_handler (uint32_t argc, char **argv)
	CLI handler for the "info" command. Logs the name and GPIO mode of all active IO handles.

Detailed Description

Function Documentation

io_cmd_w_handler()

ERR_te io_cmd_w_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "w" command. Writes a logic level to a named IO pin.

Expected invocation: io w <name> <1|on|0|off>

Searches the registered IO pool for a handle whose name matches argv[2], then calls io_write with HIGH or LOW depending on argv[3].

Parameters

[in]	argc	Argument count. Must be exactly 4.
[in]	argv	Argument list: argv[0] = "io", argv[1] = "w", argv[2] = IO name, argv[3] = "1", "on", "0", or "off".

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 4, the name is not found, or the value string is not recognized
• Propagated error from io_write on failure

Definition at line 392 of file io.c.

                                                           {
    ERR_te err;
 
    if(argc != 4) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "io_cmd_w_handler: invalid arguments"
        );
        return ERR_INVALID_ARGUMENT;
    }
 
    for(uint32_t i = 0; i < CONFIG_IO_MAX_OBJECTS; i++) {
        if(str_cmp(argv[2], internal_state.ios[i].name) == true) {
            if(str_cmp(argv[3], "0") == true ||
            str_cmp(argv[3], "off") == true) {
                err = io_write(&internal_state.ios[i], LOW);
                if(err != ERR_OK)
                    return err;
 
                return ERR_OK;
            }
            else if(str_cmp(argv[3], "1") == true ||
            str_cmp(argv[3], "on") == true) {
                err = io_write(&internal_state.ios[i], HIGH);
                if(err != ERR_OK)
                    return err;
 
                return ERR_OK;
            }
            else {
                LOG_ERROR(
                    internal_state.subsys,
                    internal_state.log_level,
                    "io_cmd_w_handler: invalid arguments"
                );
                return ERR_INVALID_ARGUMENT;
            }
        }
 
        if(i == internal_state.io_num - 1) {
            LOG_ERROR(
                internal_state.subsys,
                internal_state.log_level,
                "io_cmd_w_handler: invalid arguments"
            );
            return ERR_INVALID_ARGUMENT;
        }
    }
 
    return ERR_OK;
}

Here is the call graph for this function:

io_cmd_r_handler()

ERR_te io_cmd_r_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "r" command. Reads and logs the logic level of a named IO pin.

Expected invocation: io r <name>

Searches the registered IO pool for a handle whose name matches argv[2], then calls io_read and logs the result.

Parameters

[in]	argc	Argument count. Must be exactly 3.
[in]	argv	Argument list: argv[0] = "io", argv[1] = "r", argv[2] = IO name.

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 3 or the name is not found
• Propagated error from io_read on failure

Definition at line 463 of file io.c.

                                                           {
    ERR_te err;
 
    if(argc != 3) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "io_cmd_r_handler: invalid arguments"
        );
        return ERR_INVALID_ARGUMENT;
    }
 
    for(uint32_t i = 0; i < CONFIG_IO_MAX_OBJECTS; i++) {
        if(str_cmp(argv[2], internal_state.ios[i].name) == true) {
            PIN_STATUS_te pin_status = 0;
 
            err = io_read(&internal_state.ios[i], &pin_status);
            if(err != ERR_OK) {
                return err;
            }
 
            LOG_INFO(
                internal_state.subsys,
                internal_state.log_level,
                "io_cmd_r_handler: %s pin status: %d",
                internal_state.ios[i].name,
                pin_status
            );
 
            return ERR_OK;
        }
 
        if(i == internal_state.io_num - 1) {
            LOG_ERROR(
                internal_state.subsys,
                internal_state.log_level,
                "io_cmd_r_handler: invalid arguments"
            );
            return ERR_INVALID_ARGUMENT;
        }
    }
 
    return ERR_OK;
}

Here is the call graph for this function:

io_cmd_info_handler()

ERR_te io_cmd_info_handler ( uint32_t argc, char ** argv )

static

CLI handler for the "info" command. Logs the name and GPIO mode of all active IO handles.

Expected invocation: io info

Iterates over the internal IO pool and logs the name and GPIO mode of every slot that is currently in use.

Parameters

[in]	argc	Argument count. Must be exactly 2.
[in]	argv	Argument list: argv[0] = "io", argv[1] = "info".

Returns

• ERR_OK on success
• ERR_INVALID_ARGUMENT if argc != 2

Definition at line 524 of file io.c.

                                                              {
    if(argc != 2) {
        LOG_ERROR(
            internal_state.subsys,
            internal_state.log_level,
            "io_cmd_info_handler: invalid arguments"
        );
 
        return ERR_INVALID_ARGUMENT;
    }
 
    LOG_INFO(internal_state.subsys, internal_state.log_level, "Printing IO information:");
 
    for(uint32_t i = 0; i < CONFIG_IO_MAX_OBJECTS; i++) {
        if(internal_state.ios[i].in_use == true) {
            LOG_INFO(
                internal_state.subsys,
                internal_state.log_level,
                "name: %s, mode: %d",
                internal_state.ios[i].name,
                internal_state.ios[i].gpio_cfg.mode
            );
        }
    }
 
    return ERR_OK;
}