CLI-commands.c File Reference

FreeRTOS+CLI command examples.

Copyright (c) 2014-2018 Microchip Technology Inc. and its subsidiaries.

#include "FreeRTOS.h"
#include "task.h"
#include <stdint.h>
#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include "FreeRTOS_CLI.h"
#include "demo-tasks.h"

Functions
static portBASE_TYPE	create_task_command (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)
void	created_task (void *pvParameters)
static portBASE_TYPE	delete_task_command (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)
static portBASE_TYPE	multi_parameter_echo_command (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)
static portBASE_TYPE	run_time_stats_command (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)
static portBASE_TYPE	task_stats_command (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)
static portBASE_TYPE	three_parameter_echo_command (int8_t *pcWriteBuffer, size_t xWriteBufferLen, const int8_t *pcCommandString)
void	vRegisterCLICommands (void)

Variables
static const CLI_Command_Definition_t	create_task_command_definition
static xTaskHandle	created_task_handle = NULL
static const CLI_Command_Definition_t	delete_task_command_definition
static const CLI_Command_Definition_t	multi_parameter_echo_command_definition
static const CLI_Command_Definition_t	run_time_stats_command_definition
static const CLI_Command_Definition_t	task_stats_command_definition
static const CLI_Command_Definition_t	three_parameter_echo_command_definition

static portBASE_TYPE create_task_command ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References configASSERT, configMINIMAL_STACK_SIZE, created_task(), created_task_handle, FreeRTOS_CLIGetParameter(), NULL, pdFALSE, pdPASS, tskIDLE_PRIORITY, and xTaskCreate.

void created_task

(

void *

pvParameters

)

References vTaskDelay().

Referenced by create_task_command().

static portBASE_TYPE delete_task_command ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References configASSERT, created_task_handle, NULL, pdFALSE, and vTaskDelete().

static portBASE_TYPE multi_parameter_echo_command ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References configASSERT, FreeRTOS_CLIGetParameter(), NULL, pdFALSE, pdPASS, and pdTRUE.

static portBASE_TYPE run_time_stats_command ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References configASSERT, pdFALSE, and vTaskGetRunTimeStats().

static portBASE_TYPE task_stats_command ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References configASSERT, pdFALSE, and vTaskList().

static portBASE_TYPE three_parameter_echo_command ( int8_t *  pcWriteBuffer, size_t  xWriteBufferLen, const int8_t *  pcCommandString  )

static

References configASSERT, FreeRTOS_CLIGetParameter(), pdFALSE, pdPASS, and pdTRUE.

void vRegisterCLICommands

(

void

)

References FreeRTOS_CLIRegisterCommand().

const CLI_Command_Definition_t create_task_command_definition

static

Initial value:

=
{
    (const int8_t *const) "create-task",
    (const int8_t *const) "create-task <param>:\r\n Creates a new task that periodically writes the parameter to the CLI output\r\n\r\n",
    create_task_command, 
    1 
}

xTaskHandle created_task_handle = NULL

static

Referenced by create_task_command(), and delete_task_command().

const CLI_Command_Definition_t delete_task_command_definition

static

Initial value:

=
{
    (const int8_t *const) "delete-task",
    (const int8_t *const) "delete-task:\r\n Deletes the task created by the create-task command\r\n\r\n",
    delete_task_command, 
    0 
}

const CLI_Command_Definition_t multi_parameter_echo_command_definition

static

Initial value:

=
{
    (const int8_t *const) "echo-parameters",
    (const int8_t *const) "echo-parameters <...>:\r\n Take variable number of parameters, echos each in turn\r\n\r\n",
    multi_parameter_echo_command, 
    -1 
}

const CLI_Command_Definition_t run_time_stats_command_definition

static

Initial value:

=
{
    (const int8_t *const) "run-time-stats", 
    (const int8_t *const) "run-time-stats:\r\n Displays a table showing how much processing time each FreeRTOS task has used\r\n\r\n",
    run_time_stats_command, 
    0 
}

const CLI_Command_Definition_t task_stats_command_definition

static

Initial value:

=
{
    (const int8_t *const) "task-stats", 
    (const int8_t *const) "task-stats:\r\n Displays a table showing the state of each FreeRTOS task\r\n\r\n",
    task_stats_command, 
    0 
}

const CLI_Command_Definition_t three_parameter_echo_command_definition

static

Initial value:

=
{
    (const int8_t *const) "echo-3-parameters",
    (const int8_t *const) "echo-3-parameters <param1> <param2> <param3>:\r\n Expects three parameters, echos each in turn\r\n\r\n",
    three_parameter_echo_command, 
    3 
}