├── example.gif ├── .vscode └── settings.json ├── lib └── FreeRTOS-Plus-CLI │ ├── ReadMe.url │ ├── readme.txt │ ├── LICENSE_INFORMATION.txt │ ├── History.txt │ ├── FreeRTOS_CLI.h │ └── FreeRTOS_CLI.c ├── FreeRTOS_Shell_port.h ├── FreeRTOS_Shell_port.c ├── FreeRTOS_Shell.h ├── README.md ├── FreeRTOS_CLI.h ├── FreeRTOS_Shell.c ├── FreeRTOS_CLI.c └── LICENSE /example.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/jiladahe1997/FreeRTOS-Shell/HEAD/example.gif -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.associations": { 3 | ".wxss": "css", 4 | "*.wxss": "css", 5 | "freertos_shell_port.h": "c" 6 | } 7 | } -------------------------------------------------------------------------------- /lib/FreeRTOS-Plus-CLI/ReadMe.url: -------------------------------------------------------------------------------- 1 | [InternetShortcut] 2 | URL=http://www.freertos.org/cli 3 | IDList= 4 | [{000214A0-0000-0000-C000-000000000046}] 5 | Prop3=19,2 6 | -------------------------------------------------------------------------------- /lib/FreeRTOS-Plus-CLI/readme.txt: -------------------------------------------------------------------------------- 1 | Contains source and header files that implement FreeRTOS+CLI. See 2 | http://www.FreeRTOS.org/cli for documentation and license information. 3 | 4 | -------------------------------------------------------------------------------- /FreeRTOS_Shell_port.h: -------------------------------------------------------------------------------- 1 | #ifndef __FREERTOS_SHELL_PORT_H 2 | #define __FREERTOS_SHELL_PORT_H 3 | 4 | void FreeRTOS_ShellOutput(const char * buffer, int length); 5 | 6 | #endif /* __FREERTOS_SHELL_PORT_H */ 7 | -------------------------------------------------------------------------------- /FreeRTOS_Shell_port.c: -------------------------------------------------------------------------------- 1 | #include "FreeRTOS_Shell_port.h" 2 | #include "FreeRTOS_Shell.h" 3 | #include "stm32f4xx_hal.h" 4 | #include "cmsis_os.h" 5 | #include "semphr.h" 6 | 7 | extern UART_HandleTypeDef huart2; 8 | void FreeRTOS_ShellOutput(const char * buffer, int length) { 9 | // Please Replace below code to your board 10 | HAL_UART_Transmit(&huart2, (uint8_t*)buffer, length, length); 11 | } 12 | 13 | void USART2_IRQHandler(void) 14 | { 15 | if(huart2.Instance->SR & USART_SR_RXNE){ 16 | // 保证读取出数据，防止溢出，产生ORE错误。 17 | uint8_t recvData = READ_REG(huart2.Instance->DR); 18 | FreeRTOS_ShellIRQHandle(recvData); 19 | } 20 | } 21 | 22 | void FreeRTOS_Shell_init(void){ 23 | __HAL_UART_ENABLE_IT(&huart2, UART_IT_RXNE); 24 | } -------------------------------------------------------------------------------- /lib/FreeRTOS-Plus-CLI/LICENSE_INFORMATION.txt: -------------------------------------------------------------------------------- 1 | FreeRTOS+CLI is released under the following MIT license. 2 | 3 | Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | Permission is hereby granted, free of charge, to any person obtaining a copy of 5 | this software and associated documentation files (the "Software"), to deal in 6 | the Software without restriction, including without limitation the rights to 7 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 8 | the Software, and to permit persons to whom the Software is furnished to do so, 9 | subject to the following conditions: 10 | 11 | The above copyright notice and this permission notice shall be included in all 12 | copies or substantial portions of the Software. 13 | 14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 16 | FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 17 | COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 18 | IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 19 | CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 20 | -------------------------------------------------------------------------------- /lib/FreeRTOS-Plus-CLI/History.txt: -------------------------------------------------------------------------------- 1 | Changes between V1.0.3 and V1.0.4 released 2 | 3 | + Update to use stdint and the FreeRTOS specific typedefs that were 4 | introduced in FreeRTOS V8.0.0. 5 | 6 | Changes between V1.0.2 and V1.0.3 released 7 | 8 | + Previously, and in line with good software engineering practice, the 9 | FreeRTOS coding standard did not permit the use of char types that were 10 | not explicitly qualified as either signed or unsigned. As a result char 11 | pointers used to reference strings required casts, as did the use of any 12 | standard string handling functions. The casts ensured compiler warnings 13 | were not generated by compilers that defaulted unqualified char types to 14 | be signed or compilers that defaulted unqualified char types to be 15 | unsigned. As it has in later MISRA standards, this rule has now been 16 | relaxed, and unqualified char types are now permitted, but only when: 17 | 1) The char is used to point to a human readable text string. 18 | 2) The char is used to hold a single ASCII character. 19 | 20 | Changes between V1.0.1 and V1.0.2 released 14/10/2013 21 | 22 | + Changed double quotes (") to single quotes (') in the help string to 23 | allow the strings to be used with JSON in FreeRTOS+Nabto. 24 | 25 | Changes between V1.0.0 and V1.0.1 released 05/07/2012 26 | 27 | + Change the name of the structure used to map a function that implements 28 | a CLI command to the string used to call the command from 29 | xCommandLineInput to CLI_Command_Definition_t, as it was always intended 30 | to be. A #define was added to map the old name to the new name for 31 | reasons of backward compatibility. 32 | 33 | -------------------------------------------------------------------------------- /FreeRTOS_Shell.h: -------------------------------------------------------------------------------- 1 | #ifndef __FREERTOS_SHELL_H 2 | #define __FREERTOS_SHELL_H 3 | 4 | /* FreeRTOS-Shell macro */ 5 | #define FREERTOS_SHELL_RECV_QUEUE_LENGTH 32 6 | #define FREERTOS_SHELL_INPUT_BUFFER_LENGTH 64 7 | #define FREERTOS_SHELL_USER_INFO "[root@FreeRTOS]# " 8 | #define FREERTOS_SHELL_EACH_TASKINFO_MAX_SIZE 40 //40 bytes per task is described here: https://www.freertos.org/a00021.html#vTaskList 9 | 10 | /* FreeRTOS-CLI macro */ 11 | #define FREERTOS_CLI_OUTPUT_MAX_BUFFER_SIZE 128 12 | 13 | #include 14 | 15 | void FreeRTOS_Shell(void); 16 | void FreeRTOS_ShellIRQHandle(uint8_t recvData); 17 | 18 | #define FREERTOS_SHELL_CMD_REGISTER(pcCommand, pcHelpString, pxCommandInterpreter, cExpectedNumberOfParameters) \ 19 | CLI_Command_Definition_t FreeRTOS_Shell_CMD_definetion_##pxCommandInterpreter __attribute__((section ("FREERTOS_SHELL_CMD_SECTION"))) __attribute__((used)) = { \ 20 | pcCommand,\ 21 | pcCommand":"pcHelpString"\r\n",\ 22 | pxCommandInterpreter,\ 23 | cExpectedNumberOfParameters\ 24 | }; 25 | 26 | #define FREERTOS_SHELL_START_LOGO \ 27 | "\r\n"\ 28 | "___________ _____________________________ _________ \r\n"\ 29 | "\\_ _____/______ ____ ____\\______ \\__ ___/\\_____ \\ / _____/ \r\n"\ 30 | " | __) \\_ __ \\_/ __ \\_/ __ \\| _/ | | / | \\ \\_____ \\ \r\n"\ 31 | " | \\ | | \\/\\ ___/\\ ___/| | \\ | | / | \\/ \\ \r\n"\ 32 | " \\___ / |__| \\___ >\\___ >____|_ / |____| \\_______ /_______ / \r\n"\ 33 | " \\/ \\/ \\/ \\/ \\/ \\/ \r\n"\ 34 | " _________.__ .__ .__ \r\n"\ 35 | " / _____/| |__ ____ | | | | \r\n"\ 36 | " ______ \\_____ \\ | | \\_/ __ \\| | | | \r\n"\ 37 | " /_____/ / \\| Y \\ ___/| |_| |__ \r\n"\ 38 | " /_______ /|___| /\\___ >____/____/ \r\n"\ 39 | " \\/ \\/ \\/ \r\n"\ 40 | "\r\n" 41 | #endif /* __FREERTOS_SHELL_H */ -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Introduction 2 | FreeRTOS-Shell is a Shell for [FreeRTOS](https://www.freertos.org/), like Linux Shell or Windows CMD. 3 | 4 | ### Why this? 5 | 6 | For many embedded applications, there is few way to inactive with your application once it run and that makes things difficult. A shell provide the possibility to inactive with your application, you could use it to do many jobs, such as: 7 | 8 | - Execute function by your command 9 | - Show running log 10 | - Do unit test 11 | - Show FreeRTOS system infomation, like task status、mutex status 12 | - Provide a simple operation interface for other person to use, like Test Engineer、Hardware Engineer、Production Engineer. 13 | 14 | 15 |
16 | 17 | ![example](example.gif) 18 | 19 | # How to use 20 | 21 | the usage is simple, you just need three steps: 22 | - install: 23 | >Add essential files to your project, depending on your develop enviroment, there are different ways to implent this. 24 | - port: 25 | >FreeRTOS-shell use UART to implent INPUT and OUTPUT, you may want use your own uart settings, so your should PORT little code to adapt your boards. 26 | - start: 27 | > Start the shell. 28 | 29 | ## Install 30 | 1.STM32CubeMX 31 | 32 | TODO: https://community.st.com/s/feed/0D53W00000Cg0y8SAB 33 | 34 | 2.From source 35 | 36 | Download this reposity by using git clone or click Download ZIP. Add 3 files to your project: `FreeRTOS_CLI.c` 、`FreeRTOS_Shell.c` 、`FreeRTOS_Shell_port.c` 37 | 38 | ## Port 39 | 40 | Modify the code in `FreeRTOS_Shell_port.c`, there are only 3 functions you should port: 41 | 42 | ``` 43 | /** 44 | * @brief: this function output characters to UART 45 | * @param: buffer, the buffer to characters 46 | * @param: length, the length of buffer 47 | */ 48 | void FreeRTOS_ShellOutput(const char * buffer, int length); 49 | 50 | /** 51 | * @breif: this is the interrupt handle for uart, 52 | * Your should call FreeRTOS_ShellIRQHandle(data) every time when 53 | * receive a data. 54 | */ 55 | void USART2_IRQHandler(void); 56 | 57 | /** 58 | * @breif: this function is defined as __WEAK, and will be called when the shell task start, you could redefine this function to do some initialization work. 59 | */ 60 | void FreeRTOS_Shell_init(void); 61 | ``` 62 | 63 | ## Start 64 | ``` 65 | /* Just create a simple FreeRTOS task */ 66 | osThreadId_t ShellHandle; 67 | const osThreadAttr_t Shell_attributes = { 68 | .name = "Shell", 69 | .priority = (osPriority_t) osPriorityNormal1, 70 | .stack_size = 128 * 4 71 | }; 72 | ShellHandle = osThreadNew(FreeRTOS_Shell, NULL, &Shell_attributes); 73 | ``` 74 | 75 | 76 | 77 | # Features 78 | - fast command register, out of user logic, 79 | 80 | >you could register command by using `FREERTOS_SHELL_CMD_REGISTER` out of any function. 81 | ``` 82 | static BaseType_t listAllThread(char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString){ 83 | ... 84 | } 85 | 86 | FREERTOS_SHELL_CMD_REGISTER("ps", "list all thread", listAllThread, 0); 87 | ``` 88 | - modifiable logo 89 | 90 | >generate your own logo here: http://www.network-science.de/ascii/. and then replace the macro FREERTOS_SHELL_START_LOGO in `FreeRTOS_Shell.h` 91 | 92 | - modifiable logo username 93 | 94 | >modify the macro FREERTOS_SHELL_USER_INFO in `FreeRTOS_Shell.h` 95 | 96 | - ...more features in development 97 | 98 | 99 | # How a shell work? 100 | 101 | A shell works as parse user INPUT、run functions and then OUTPUT the result. A Shell could be implented by different ways, as long as your application could provide an interface which could INPUT and OUTPUT. For convinence, most shell using [UART](https://en.wikipedia.org/wiki/Universal_asynchronous_receiver-transmitter). 102 | 103 | # TODO 104 | 105 | 1.适配GCC编译器
106 | 2.增加更多的FreeRTOS内置API
107 | 3.增加线程hardfault信息打印
108 | 4.增加STM32CubeMX包
109 | 5.测试更多芯片
110 | 6.增加example项目 111 | 112 | 113 | # Thanks 114 | RT-thread
115 | FreeRTOS-CLI 116 | -------------------------------------------------------------------------------- /FreeRTOS_CLI.h: -------------------------------------------------------------------------------- 1 | /* 2 | * FreeRTOS+CLI V1.0.4 3 | * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | * 5 | * Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | * this software and associated documentation files (the "Software"), to deal in 7 | * the Software without restriction, including without limitation the rights to 8 | * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | * the Software, and to permit persons to whom the Software is furnished to do so, 10 | * subject to the following conditions: 11 | * 12 | * The above copyright notice and this permission notice shall be included in all 13 | * copies or substantial portions of the Software. 14 | * 15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | * 22 | * http://www.FreeRTOS.org 23 | * http://aws.amazon.com/freertos 24 | * 25 | * 1 tab == 4 spaces! 26 | */ 27 | 28 | #ifndef COMMAND_INTERPRETER_H 29 | #define COMMAND_INTERPRETER_H 30 | 31 | #define configCOMMAND_INT_MAX_OUTPUT_SIZE 32 32 | 33 | /* The prototype to which callback functions used to process command line 34 | commands must comply. pcWriteBuffer is a buffer into which the output from 35 | executing the command can be written, xWriteBufferLen is the length, in bytes of 36 | the pcWriteBuffer buffer, and pcCommandString is the entire string as input by 37 | the user (from which parameters can be extracted).*/ 38 | typedef BaseType_t (*pdCOMMAND_LINE_CALLBACK)( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString ); 39 | 40 | /* The structure that defines command line commands. A command line command 41 | should be defined by declaring a const structure of this type. */ 42 | typedef struct xCOMMAND_LINE_INPUT 43 | { 44 | const char * const pcCommand; /* The command that causes pxCommandInterpreter to be executed. For example "help". Must be all lower case. */ 45 | const char * const pcHelpString; /* String that describes how to use the command. Should start with the command itself, and end with "\r\n". For example "help: Returns a list of all the commands\r\n". */ 46 | const pdCOMMAND_LINE_CALLBACK pxCommandInterpreter; /* A pointer to the callback function that will return the output generated by the command. */ 47 | int8_t cExpectedNumberOfParameters; /* Commands expect a fixed number of parameters, which may be zero. */ 48 | } CLI_Command_Definition_t; 49 | 50 | /* For backward compatibility. */ 51 | #define xCommandLineInput CLI_Command_Definition_t 52 | 53 | /* 54 | * Register the command passed in using the pxCommandToRegister parameter. 55 | * Registering a command adds the command to the list of commands that are 56 | * handled by the command interpreter. Once a command has been registered it 57 | * can be executed from the command line. 58 | */ 59 | BaseType_t FreeRTOS_CLIRegisterCommand( const CLI_Command_Definition_t * const pxCommandToRegister ); 60 | 61 | /* 62 | * Runs the command interpreter for the command string "pcCommandInput". Any 63 | * output generated by running the command will be placed into pcWriteBuffer. 64 | * xWriteBufferLen must indicate the size, in bytes, of the buffer pointed to 65 | * by pcWriteBuffer. 66 | * 67 | * FreeRTOS_CLIProcessCommand should be called repeatedly until it returns pdFALSE. 68 | * 69 | * pcCmdIntProcessCommand is not reentrant. It must not be called from more 70 | * than one task - or at least - by more than one task at a time. 71 | */ 72 | BaseType_t FreeRTOS_CLIProcessCommand( const char * const pcCommandInput, char * pcWriteBuffer, size_t xWriteBufferLen ); 73 | 74 | /*-----------------------------------------------------------*/ 75 | 76 | /* 77 | * A buffer into which command outputs can be written is declared in the 78 | * main command interpreter, rather than in the command console implementation, 79 | * to allow application that provide access to the command console via multiple 80 | * interfaces to share a buffer, and therefore save RAM. Note, however, that 81 | * the command interpreter itself is not re-entrant, so only one command 82 | * console interface can be used at any one time. For that reason, no attempt 83 | * is made to provide any mutual exclusion mechanism on the output buffer. 84 | * 85 | * FreeRTOS_CLIGetOutputBuffer() returns the address of the output buffer. 86 | */ 87 | char *FreeRTOS_CLIGetOutputBuffer( void ); 88 | 89 | /* 90 | * Return a pointer to the xParameterNumber'th word in pcCommandString. 91 | */ 92 | const char *FreeRTOS_CLIGetParameter( const char *pcCommandString, UBaseType_t uxWantedParameter, BaseType_t *pxParameterStringLength ); 93 | 94 | #endif /* COMMAND_INTERPRETER_H */ 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | -------------------------------------------------------------------------------- /lib/FreeRTOS-Plus-CLI/FreeRTOS_CLI.h: -------------------------------------------------------------------------------- 1 | /* 2 | * FreeRTOS+CLI V1.0.4 3 | * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | * 5 | * Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | * this software and associated documentation files (the "Software"), to deal in 7 | * the Software without restriction, including without limitation the rights to 8 | * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | * the Software, and to permit persons to whom the Software is furnished to do so, 10 | * subject to the following conditions: 11 | * 12 | * The above copyright notice and this permission notice shall be included in all 13 | * copies or substantial portions of the Software. 14 | * 15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | * 22 | * http://www.FreeRTOS.org 23 | * http://aws.amazon.com/freertos 24 | * 25 | * 1 tab == 4 spaces! 26 | */ 27 | 28 | #ifndef COMMAND_INTERPRETER_H 29 | #define COMMAND_INTERPRETER_H 30 | 31 | #define configCOMMAND_INT_MAX_OUTPUT_SIZE 32 32 | 33 | /* The prototype to which callback functions used to process command line 34 | commands must comply. pcWriteBuffer is a buffer into which the output from 35 | executing the command can be written, xWriteBufferLen is the length, in bytes of 36 | the pcWriteBuffer buffer, and pcCommandString is the entire string as input by 37 | the user (from which parameters can be extracted).*/ 38 | typedef BaseType_t (*pdCOMMAND_LINE_CALLBACK)( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString ); 39 | 40 | /* The structure that defines command line commands. A command line command 41 | should be defined by declaring a const structure of this type. */ 42 | typedef struct xCOMMAND_LINE_INPUT 43 | { 44 | const char * const pcCommand; /* The command that causes pxCommandInterpreter to be executed. For example "help". Must be all lower case. */ 45 | const char * const pcHelpString; /* String that describes how to use the command. Should start with the command itself, and end with "\r\n". For example "help: Returns a list of all the commands\r\n". */ 46 | const pdCOMMAND_LINE_CALLBACK pxCommandInterpreter; /* A pointer to the callback function that will return the output generated by the command. */ 47 | int8_t cExpectedNumberOfParameters; /* Commands expect a fixed number of parameters, which may be zero. */ 48 | } CLI_Command_Definition_t; 49 | 50 | /* For backward compatibility. */ 51 | #define xCommandLineInput CLI_Command_Definition_t 52 | 53 | /* 54 | * Register the command passed in using the pxCommandToRegister parameter. 55 | * Registering a command adds the command to the list of commands that are 56 | * handled by the command interpreter. Once a command has been registered it 57 | * can be executed from the command line. 58 | */ 59 | BaseType_t FreeRTOS_CLIRegisterCommand( const CLI_Command_Definition_t * const pxCommandToRegister ); 60 | 61 | /* 62 | * Runs the command interpreter for the command string "pcCommandInput". Any 63 | * output generated by running the command will be placed into pcWriteBuffer. 64 | * xWriteBufferLen must indicate the size, in bytes, of the buffer pointed to 65 | * by pcWriteBuffer. 66 | * 67 | * FreeRTOS_CLIProcessCommand should be called repeatedly until it returns pdFALSE. 68 | * 69 | * pcCmdIntProcessCommand is not reentrant. It must not be called from more 70 | * than one task - or at least - by more than one task at a time. 71 | */ 72 | BaseType_t FreeRTOS_CLIProcessCommand( const char * const pcCommandInput, char * pcWriteBuffer, size_t xWriteBufferLen ); 73 | 74 | /*-----------------------------------------------------------*/ 75 | 76 | /* 77 | * A buffer into which command outputs can be written is declared in the 78 | * main command interpreter, rather than in the command console implementation, 79 | * to allow application that provide access to the command console via multiple 80 | * interfaces to share a buffer, and therefore save RAM. Note, however, that 81 | * the command interpreter itself is not re-entrant, so only one command 82 | * console interface can be used at any one time. For that reason, no attempt 83 | * is made to provide any mutual exclusion mechanism on the output buffer. 84 | * 85 | * FreeRTOS_CLIGetOutputBuffer() returns the address of the output buffer. 86 | */ 87 | char *FreeRTOS_CLIGetOutputBuffer( void ); 88 | 89 | /* 90 | * Return a pointer to the xParameterNumber'th word in pcCommandString. 91 | */ 92 | const char *FreeRTOS_CLIGetParameter( const char *pcCommandString, UBaseType_t uxWantedParameter, BaseType_t *pxParameterStringLength ); 93 | 94 | #endif /* COMMAND_INTERPRETER_H */ 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | -------------------------------------------------------------------------------- /FreeRTOS_Shell.c: -------------------------------------------------------------------------------- 1 | /* FreeRTOS includes. */ 2 | #include "FreeRTOS.h" 3 | #include "queue.h" 4 | #include "task.h" 5 | 6 | /* Standard includes. */ 7 | #include 8 | #include 9 | #include 10 | #include 11 | 12 | /* custom includes. */ 13 | #include "FreeRTOS_Shell.h" 14 | #include "FreeRTOS_Shell_port.h" 15 | #include "FreeRTOS_CLI.h" 16 | 17 | /* Private variables ---------------------------------------------------------*/ 18 | QueueHandle_t FreeRTOS_ShellRecvQueue; 19 | static uint8_t inputBuffer[FREERTOS_SHELL_INPUT_BUFFER_LENGTH]; 20 | static uint8_t *inputBuffer_ptr; 21 | static uint8_t outputBuffer[FREERTOS_CLI_OUTPUT_MAX_BUFFER_SIZE]; 22 | 23 | /* Extern variables ---------------------------------------------------------*/ 24 | extern uint8_t FREERTOS_SHELL_CMD_SECTION$$Base; 25 | extern uint8_t FREERTOS_SHELL_CMD_SECTION$$Limit; 26 | 27 | /* Private function prototypes -----------------------------------------------*/ 28 | __WEAK void FreeRTOS_Shell_init(void){} 29 | 30 | 31 | /** 32 | * @brief A FreeRTOS thread, it will handle msg from a msgqueue, and output to UART 33 | * 34 | * @note when there is no input, the thread will suspend and take no CPU time. 35 | */ 36 | void FreeRTOS_Shell(void){ 37 | FreeRTOS_Shell_init(); 38 | /* a shell task */ 39 | inputBuffer_ptr = inputBuffer; 40 | FreeRTOS_ShellRecvQueue = xQueueCreate(FREERTOS_SHELL_RECV_QUEUE_LENGTH, sizeof(uint8_t)); 41 | configASSERT(FreeRTOS_ShellRecvQueue); 42 | 43 | FreeRTOS_ShellOutput(FREERTOS_SHELL_START_LOGO, strlen(FREERTOS_SHELL_START_LOGO)); 44 | FreeRTOS_ShellOutput("\r\n",2); 45 | FreeRTOS_ShellOutput(FREERTOS_SHELL_USER_INFO, strlen(FREERTOS_SHELL_USER_INFO)); 46 | 47 | /* regist all cmd using link symbol */ 48 | uint8_t* start = &FREERTOS_SHELL_CMD_SECTION$$Base; 49 | uint8_t* end = &FREERTOS_SHELL_CMD_SECTION$$Limit; 50 | int size = sizeof(CLI_Command_Definition_t); 51 | for(uint8_t* i=start;i xWriteBufferLen * (listAllThreadCallCount + 1)) 117 | { 118 | /* Insufficient buffer size, should be called more than once */ 119 | memcpy(pcWriteBuffer, _buffer + xWriteBufferLen * listAllThreadCallCount, xWriteBufferLen); 120 | listAllThreadCallCount++; 121 | ret = pdTRUE; 122 | } 123 | else 124 | { 125 | /* sufficient buffer size */ 126 | memcpy(pcWriteBuffer, _buffer + xWriteBufferLen * listAllThreadCallCount, xWriteBufferLen * (listAllThreadCallCount + 1) - len); 127 | listAllThreadCallCount--; 128 | ret = pdFALSE; 129 | } 130 | 131 | end: 132 | free(_buffer); 133 | return ret; 134 | } 135 | 136 | FREERTOS_SHELL_CMD_REGISTER("ps", "list all thread", listAllThread, 0); -------------------------------------------------------------------------------- /FreeRTOS_CLI.c: -------------------------------------------------------------------------------- 1 | /* 2 | * FreeRTOS+CLI V1.0.4 3 | * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | * 5 | * Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | * this software and associated documentation files (the "Software"), to deal in 7 | * the Software without restriction, including without limitation the rights to 8 | * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | * the Software, and to permit persons to whom the Software is furnished to do so, 10 | * subject to the following conditions: 11 | * 12 | * The above copyright notice and this permission notice shall be included in all 13 | * copies or substantial portions of the Software. 14 | * 15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | * 22 | * http://www.FreeRTOS.org 23 | * http://aws.amazon.com/freertos 24 | * 25 | * 1 tab == 4 spaces! 26 | */ 27 | 28 | /* Standard includes. */ 29 | #include 30 | #include 31 | 32 | /* FreeRTOS includes. */ 33 | #include "FreeRTOS.h" 34 | #include "task.h" 35 | 36 | /* Utils includes. */ 37 | #include "FreeRTOS_CLI.h" 38 | 39 | /* If the application writer needs to place the buffer used by the CLI at a 40 | fixed address then set configAPPLICATION_PROVIDES_cOutputBuffer to 1 in 41 | FreeRTOSConfig.h, then declare an array with the following name and size in 42 | one of the application files: 43 | char cOutputBuffer[ configCOMMAND_INT_MAX_OUTPUT_SIZE ]; 44 | */ 45 | #ifndef configAPPLICATION_PROVIDES_cOutputBuffer 46 | #define configAPPLICATION_PROVIDES_cOutputBuffer 0 47 | #endif 48 | 49 | typedef struct xCOMMAND_INPUT_LIST 50 | { 51 | const CLI_Command_Definition_t *pxCommandLineDefinition; 52 | struct xCOMMAND_INPUT_LIST *pxNext; 53 | } CLI_Definition_List_Item_t; 54 | 55 | /* 56 | * The callback function that is executed when "help" is entered. This is the 57 | * only default command that is always present. 58 | */ 59 | static BaseType_t prvHelpCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString ); 60 | 61 | /* 62 | * Return the number of parameters that follow the command name. 63 | */ 64 | static int8_t prvGetNumberOfParameters( const char *pcCommandString ); 65 | 66 | /* The definition of the "help" command. This command is always at the front 67 | of the list of registered commands. */ 68 | static const CLI_Command_Definition_t xHelpCommand = 69 | { 70 | "help", 71 | "\r\nhelp:\r\n Lists all the registered commands\r\n\r\n", 72 | prvHelpCommand, 73 | 0 74 | }; 75 | 76 | /* The definition of the list of commands. Commands that are registered are 77 | added to this list. */ 78 | static CLI_Definition_List_Item_t xRegisteredCommands = 79 | { 80 | &xHelpCommand, /* The first command in the list is always the help command, defined in this file. */ 81 | NULL /* The next pointer is initialised to NULL, as there are no other registered commands yet. */ 82 | }; 83 | 84 | /* A buffer into which command outputs can be written is declared here, rather 85 | than in the command console implementation, to allow multiple command consoles 86 | to share the same buffer. For example, an application may allow access to the 87 | command interpreter by UART and by Ethernet. Sharing a buffer is done purely 88 | to save RAM. Note, however, that the command console itself is not re-entrant, 89 | so only one command interpreter interface can be used at any one time. For that 90 | reason, no attempt at providing mutual exclusion to the cOutputBuffer array is 91 | attempted. 92 | 93 | configAPPLICATION_PROVIDES_cOutputBuffer is provided to allow the application 94 | writer to provide their own cOutputBuffer declaration in cases where the 95 | buffer needs to be placed at a fixed address (rather than by the linker). */ 96 | #if( configAPPLICATION_PROVIDES_cOutputBuffer == 0 ) 97 | static char cOutputBuffer[ configCOMMAND_INT_MAX_OUTPUT_SIZE ]; 98 | #else 99 | extern char cOutputBuffer[ configCOMMAND_INT_MAX_OUTPUT_SIZE ]; 100 | #endif 101 | 102 | 103 | /*-----------------------------------------------------------*/ 104 | 105 | BaseType_t FreeRTOS_CLIRegisterCommand( const CLI_Command_Definition_t * const pxCommandToRegister ) 106 | { 107 | static CLI_Definition_List_Item_t *pxLastCommandInList = &xRegisteredCommands; 108 | CLI_Definition_List_Item_t *pxNewListItem; 109 | BaseType_t xReturn = pdFAIL; 110 | 111 | /* Check the parameter is not NULL. */ 112 | configASSERT( pxCommandToRegister ); 113 | 114 | /* Create a new list item that will reference the command being registered. */ 115 | pxNewListItem = ( CLI_Definition_List_Item_t * ) pvPortMalloc( sizeof( CLI_Definition_List_Item_t ) ); 116 | configASSERT( pxNewListItem ); 117 | 118 | if( pxNewListItem != NULL ) 119 | { 120 | taskENTER_CRITICAL(); 121 | { 122 | /* Reference the command being registered from the newly created 123 | list item. */ 124 | pxNewListItem->pxCommandLineDefinition = pxCommandToRegister; 125 | 126 | /* The new list item will get added to the end of the list, so 127 | pxNext has nowhere to point. */ 128 | pxNewListItem->pxNext = NULL; 129 | 130 | /* Add the newly created list item to the end of the already existing 131 | list. */ 132 | pxLastCommandInList->pxNext = pxNewListItem; 133 | 134 | /* Set the end of list marker to the new list item. */ 135 | pxLastCommandInList = pxNewListItem; 136 | } 137 | taskEXIT_CRITICAL(); 138 | 139 | xReturn = pdPASS; 140 | } 141 | 142 | return xReturn; 143 | } 144 | /*-----------------------------------------------------------*/ 145 | 146 | BaseType_t FreeRTOS_CLIProcessCommand( const char * const pcCommandInput, char * pcWriteBuffer, size_t xWriteBufferLen ) 147 | { 148 | static const CLI_Definition_List_Item_t *pxCommand = NULL; 149 | BaseType_t xReturn = pdTRUE; 150 | const char *pcRegisteredCommandString; 151 | size_t xCommandStringLength; 152 | 153 | /* Note: This function is not re-entrant. It must not be called from more 154 | thank one task. */ 155 | 156 | if( pxCommand == NULL ) 157 | { 158 | /* Search for the command string in the list of registered commands. */ 159 | for( pxCommand = &xRegisteredCommands; pxCommand != NULL; pxCommand = pxCommand->pxNext ) 160 | { 161 | pcRegisteredCommandString = pxCommand->pxCommandLineDefinition->pcCommand; 162 | xCommandStringLength = strlen( pcRegisteredCommandString ); 163 | 164 | /* To ensure the string lengths match exactly, so as not to pick up 165 | a sub-string of a longer command, check the byte after the expected 166 | end of the string is either the end of the string or a space before 167 | a parameter. */ 168 | if( ( pcCommandInput[ xCommandStringLength ] == ' ' ) || ( pcCommandInput[ xCommandStringLength ] == 0x00 ) ) 169 | { 170 | if( strncmp( pcCommandInput, pcRegisteredCommandString, xCommandStringLength ) == 0 ) 171 | { 172 | /* The command has been found. Check it has the expected 173 | number of parameters. If cExpectedNumberOfParameters is -1, 174 | then there could be a variable number of parameters and no 175 | check is made. */ 176 | if( pxCommand->pxCommandLineDefinition->cExpectedNumberOfParameters >= 0 ) 177 | { 178 | if( prvGetNumberOfParameters( pcCommandInput ) != pxCommand->pxCommandLineDefinition->cExpectedNumberOfParameters ) 179 | { 180 | xReturn = pdFALSE; 181 | } 182 | } 183 | 184 | break; 185 | } 186 | } 187 | } 188 | } 189 | 190 | if( ( pxCommand != NULL ) && ( xReturn == pdFALSE ) ) 191 | { 192 | /* The command was found, but the number of parameters with the command 193 | was incorrect. */ 194 | strncpy( pcWriteBuffer, "Incorrect command parameter(s). Enter \"help\" to view a list of available commands.\r\n\r\n", xWriteBufferLen ); 195 | pxCommand = NULL; 196 | } 197 | else if( pxCommand != NULL ) 198 | { 199 | /* Call the callback function that is registered to this command. */ 200 | xReturn = pxCommand->pxCommandLineDefinition->pxCommandInterpreter( pcWriteBuffer, xWriteBufferLen, pcCommandInput ); 201 | 202 | /* If xReturn is pdFALSE, then no further strings will be returned 203 | after this one, and pxCommand can be reset to NULL ready to search 204 | for the next entered command. */ 205 | if( xReturn == pdFALSE ) 206 | { 207 | pxCommand = NULL; 208 | } 209 | } 210 | else 211 | { 212 | /* pxCommand was NULL, the command was not found. */ 213 | strncpy( pcWriteBuffer, "Command not recognised. Enter 'help' to view a list of available commands.\r\n\r\n", xWriteBufferLen ); 214 | xReturn = pdFALSE; 215 | } 216 | 217 | return xReturn; 218 | } 219 | /*-----------------------------------------------------------*/ 220 | 221 | char *FreeRTOS_CLIGetOutputBuffer( void ) 222 | { 223 | return cOutputBuffer; 224 | } 225 | /*-----------------------------------------------------------*/ 226 | 227 | const char *FreeRTOS_CLIGetParameter( const char *pcCommandString, UBaseType_t uxWantedParameter, BaseType_t *pxParameterStringLength ) 228 | { 229 | UBaseType_t uxParametersFound = 0; 230 | const char *pcReturn = NULL; 231 | 232 | *pxParameterStringLength = 0; 233 | 234 | while( uxParametersFound < uxWantedParameter ) 235 | { 236 | /* Index the character pointer past the current word. If this is the start 237 | of the command string then the first word is the command itself. */ 238 | while( ( ( *pcCommandString ) != 0x00 ) && ( ( *pcCommandString ) != ' ' ) ) 239 | { 240 | pcCommandString++; 241 | } 242 | 243 | /* Find the start of the next string. */ 244 | while( ( ( *pcCommandString ) != 0x00 ) && ( ( *pcCommandString ) == ' ' ) ) 245 | { 246 | pcCommandString++; 247 | } 248 | 249 | /* Was a string found? */ 250 | if( *pcCommandString != 0x00 ) 251 | { 252 | /* Is this the start of the required parameter? */ 253 | uxParametersFound++; 254 | 255 | if( uxParametersFound == uxWantedParameter ) 256 | { 257 | /* How long is the parameter? */ 258 | pcReturn = pcCommandString; 259 | while( ( ( *pcCommandString ) != 0x00 ) && ( ( *pcCommandString ) != ' ' ) ) 260 | { 261 | ( *pxParameterStringLength )++; 262 | pcCommandString++; 263 | } 264 | 265 | if( *pxParameterStringLength == 0 ) 266 | { 267 | pcReturn = NULL; 268 | } 269 | 270 | break; 271 | } 272 | } 273 | else 274 | { 275 | break; 276 | } 277 | } 278 | 279 | return pcReturn; 280 | } 281 | /*-----------------------------------------------------------*/ 282 | 283 | static BaseType_t prvHelpCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString ) 284 | { 285 | static const CLI_Definition_List_Item_t * pxCommand = NULL; 286 | BaseType_t xReturn; 287 | 288 | ( void ) pcCommandString; 289 | 290 | if( pxCommand == NULL ) 291 | { 292 | /* Reset the pxCommand pointer back to the start of the list. */ 293 | pxCommand = &xRegisteredCommands; 294 | } 295 | 296 | /* Return the next command help string, before moving the pointer on to 297 | the next command in the list. */ 298 | strncpy( pcWriteBuffer, pxCommand->pxCommandLineDefinition->pcHelpString, xWriteBufferLen ); 299 | pxCommand = pxCommand->pxNext; 300 | 301 | if( pxCommand == NULL ) 302 | { 303 | /* There are no more commands in the list, so there will be no more 304 | strings to return after this one and pdFALSE should be returned. */ 305 | xReturn = pdFALSE; 306 | } 307 | else 308 | { 309 | xReturn = pdTRUE; 310 | } 311 | 312 | return xReturn; 313 | } 314 | /*-----------------------------------------------------------*/ 315 | 316 | static int8_t prvGetNumberOfParameters( const char *pcCommandString ) 317 | { 318 | int8_t cParameters = 0; 319 | BaseType_t xLastCharacterWasSpace = pdFALSE; 320 | 321 | /* Count the number of space delimited words in pcCommandString. */ 322 | while( *pcCommandString != 0x00 ) 323 | { 324 | if( ( *pcCommandString ) == ' ' ) 325 | { 326 | if( xLastCharacterWasSpace != pdTRUE ) 327 | { 328 | cParameters++; 329 | xLastCharacterWasSpace = pdTRUE; 330 | } 331 | } 332 | else 333 | { 334 | xLastCharacterWasSpace = pdFALSE; 335 | } 336 | 337 | pcCommandString++; 338 | } 339 | 340 | /* If the command string ended with spaces, then there will have been too 341 | many parameters counted. */ 342 | if( xLastCharacterWasSpace == pdTRUE ) 343 | { 344 | cParameters--; 345 | } 346 | 347 | /* The value returned is one less than the number of space delimited words, 348 | as the first word should be the command itself. */ 349 | return cParameters; 350 | } 351 | 352 | -------------------------------------------------------------------------------- /lib/FreeRTOS-Plus-CLI/FreeRTOS_CLI.c: -------------------------------------------------------------------------------- 1 | /* 2 | * FreeRTOS+CLI V1.0.4 3 | * Copyright (C) 2017 Amazon.com, Inc. or its affiliates. All Rights Reserved. 4 | * 5 | * Permission is hereby granted, free of charge, to any person obtaining a copy of 6 | * this software and associated documentation files (the "Software"), to deal in 7 | * the Software without restriction, including without limitation the rights to 8 | * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 9 | * the Software, and to permit persons to whom the Software is furnished to do so, 10 | * subject to the following conditions: 11 | * 12 | * The above copyright notice and this permission notice shall be included in all 13 | * copies or substantial portions of the Software. 14 | * 15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 17 | * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 18 | * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 19 | * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 20 | * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 21 | * 22 | * http://www.FreeRTOS.org 23 | * http://aws.amazon.com/freertos 24 | * 25 | * 1 tab == 4 spaces! 26 | */ 27 | 28 | /* Standard includes. */ 29 | #include 30 | #include 31 | 32 | /* FreeRTOS includes. */ 33 | #include "FreeRTOS.h" 34 | #include "task.h" 35 | 36 | /* Utils includes. */ 37 | #include "FreeRTOS_CLI.h" 38 | 39 | /* If the application writer needs to place the buffer used by the CLI at a 40 | fixed address then set configAPPLICATION_PROVIDES_cOutputBuffer to 1 in 41 | FreeRTOSConfig.h, then declare an array with the following name and size in 42 | one of the application files: 43 | char cOutputBuffer[ configCOMMAND_INT_MAX_OUTPUT_SIZE ]; 44 | */ 45 | #ifndef configAPPLICATION_PROVIDES_cOutputBuffer 46 | #define configAPPLICATION_PROVIDES_cOutputBuffer 0 47 | #endif 48 | 49 | typedef struct xCOMMAND_INPUT_LIST 50 | { 51 | const CLI_Command_Definition_t *pxCommandLineDefinition; 52 | struct xCOMMAND_INPUT_LIST *pxNext; 53 | } CLI_Definition_List_Item_t; 54 | 55 | /* 56 | * The callback function that is executed when "help" is entered. This is the 57 | * only default command that is always present. 58 | */ 59 | static BaseType_t prvHelpCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString ); 60 | 61 | /* 62 | * Return the number of parameters that follow the command name. 63 | */ 64 | static int8_t prvGetNumberOfParameters( const char *pcCommandString ); 65 | 66 | /* The definition of the "help" command. This command is always at the front 67 | of the list of registered commands. */ 68 | static const CLI_Command_Definition_t xHelpCommand = 69 | { 70 | "help", 71 | "\r\nhelp:\r\n Lists all the registered commands\r\n\r\n", 72 | prvHelpCommand, 73 | 0 74 | }; 75 | 76 | /* The definition of the list of commands. Commands that are registered are 77 | added to this list. */ 78 | static CLI_Definition_List_Item_t xRegisteredCommands = 79 | { 80 | &xHelpCommand, /* The first command in the list is always the help command, defined in this file. */ 81 | NULL /* The next pointer is initialised to NULL, as there are no other registered commands yet. */ 82 | }; 83 | 84 | /* A buffer into which command outputs can be written is declared here, rather 85 | than in the command console implementation, to allow multiple command consoles 86 | to share the same buffer. For example, an application may allow access to the 87 | command interpreter by UART and by Ethernet. Sharing a buffer is done purely 88 | to save RAM. Note, however, that the command console itself is not re-entrant, 89 | so only one command interpreter interface can be used at any one time. For that 90 | reason, no attempt at providing mutual exclusion to the cOutputBuffer array is 91 | attempted. 92 | 93 | configAPPLICATION_PROVIDES_cOutputBuffer is provided to allow the application 94 | writer to provide their own cOutputBuffer declaration in cases where the 95 | buffer needs to be placed at a fixed address (rather than by the linker). */ 96 | #if( configAPPLICATION_PROVIDES_cOutputBuffer == 0 ) 97 | static char cOutputBuffer[ configCOMMAND_INT_MAX_OUTPUT_SIZE ]; 98 | #else 99 | extern char cOutputBuffer[ configCOMMAND_INT_MAX_OUTPUT_SIZE ]; 100 | #endif 101 | 102 | 103 | /*-----------------------------------------------------------*/ 104 | 105 | BaseType_t FreeRTOS_CLIRegisterCommand( const CLI_Command_Definition_t * const pxCommandToRegister ) 106 | { 107 | static CLI_Definition_List_Item_t *pxLastCommandInList = &xRegisteredCommands; 108 | CLI_Definition_List_Item_t *pxNewListItem; 109 | BaseType_t xReturn = pdFAIL; 110 | 111 | /* Check the parameter is not NULL. */ 112 | configASSERT( pxCommandToRegister ); 113 | 114 | /* Create a new list item that will reference the command being registered. */ 115 | pxNewListItem = ( CLI_Definition_List_Item_t * ) pvPortMalloc( sizeof( CLI_Definition_List_Item_t ) ); 116 | configASSERT( pxNewListItem ); 117 | 118 | if( pxNewListItem != NULL ) 119 | { 120 | taskENTER_CRITICAL(); 121 | { 122 | /* Reference the command being registered from the newly created 123 | list item. */ 124 | pxNewListItem->pxCommandLineDefinition = pxCommandToRegister; 125 | 126 | /* The new list item will get added to the end of the list, so 127 | pxNext has nowhere to point. */ 128 | pxNewListItem->pxNext = NULL; 129 | 130 | /* Add the newly created list item to the end of the already existing 131 | list. */ 132 | pxLastCommandInList->pxNext = pxNewListItem; 133 | 134 | /* Set the end of list marker to the new list item. */ 135 | pxLastCommandInList = pxNewListItem; 136 | } 137 | taskEXIT_CRITICAL(); 138 | 139 | xReturn = pdPASS; 140 | } 141 | 142 | return xReturn; 143 | } 144 | /*-----------------------------------------------------------*/ 145 | 146 | BaseType_t FreeRTOS_CLIProcessCommand( const char * const pcCommandInput, char * pcWriteBuffer, size_t xWriteBufferLen ) 147 | { 148 | static const CLI_Definition_List_Item_t *pxCommand = NULL; 149 | BaseType_t xReturn = pdTRUE; 150 | const char *pcRegisteredCommandString; 151 | size_t xCommandStringLength; 152 | 153 | /* Note: This function is not re-entrant. It must not be called from more 154 | thank one task. */ 155 | 156 | if( pxCommand == NULL ) 157 | { 158 | /* Search for the command string in the list of registered commands. */ 159 | for( pxCommand = &xRegisteredCommands; pxCommand != NULL; pxCommand = pxCommand->pxNext ) 160 | { 161 | pcRegisteredCommandString = pxCommand->pxCommandLineDefinition->pcCommand; 162 | xCommandStringLength = strlen( pcRegisteredCommandString ); 163 | 164 | /* To ensure the string lengths match exactly, so as not to pick up 165 | a sub-string of a longer command, check the byte after the expected 166 | end of the string is either the end of the string or a space before 167 | a parameter. */ 168 | if( ( pcCommandInput[ xCommandStringLength ] == ' ' ) || ( pcCommandInput[ xCommandStringLength ] == 0x00 ) ) 169 | { 170 | if( strncmp( pcCommandInput, pcRegisteredCommandString, xCommandStringLength ) == 0 ) 171 | { 172 | /* The command has been found. Check it has the expected 173 | number of parameters. If cExpectedNumberOfParameters is -1, 174 | then there could be a variable number of parameters and no 175 | check is made. */ 176 | if( pxCommand->pxCommandLineDefinition->cExpectedNumberOfParameters >= 0 ) 177 | { 178 | if( prvGetNumberOfParameters( pcCommandInput ) != pxCommand->pxCommandLineDefinition->cExpectedNumberOfParameters ) 179 | { 180 | xReturn = pdFALSE; 181 | } 182 | } 183 | 184 | break; 185 | } 186 | } 187 | } 188 | } 189 | 190 | if( ( pxCommand != NULL ) && ( xReturn == pdFALSE ) ) 191 | { 192 | /* The command was found, but the number of parameters with the command 193 | was incorrect. */ 194 | strncpy( pcWriteBuffer, "Incorrect command parameter(s). Enter \"help\" to view a list of available commands.\r\n\r\n", xWriteBufferLen ); 195 | pxCommand = NULL; 196 | } 197 | else if( pxCommand != NULL ) 198 | { 199 | /* Call the callback function that is registered to this command. */ 200 | xReturn = pxCommand->pxCommandLineDefinition->pxCommandInterpreter( pcWriteBuffer, xWriteBufferLen, pcCommandInput ); 201 | 202 | /* If xReturn is pdFALSE, then no further strings will be returned 203 | after this one, and pxCommand can be reset to NULL ready to search 204 | for the next entered command. */ 205 | if( xReturn == pdFALSE ) 206 | { 207 | pxCommand = NULL; 208 | } 209 | } 210 | else 211 | { 212 | /* pxCommand was NULL, the command was not found. */ 213 | strncpy( pcWriteBuffer, "Command not recognised. Enter 'help' to view a list of available commands.\r\n\r\n", xWriteBufferLen ); 214 | xReturn = pdFALSE; 215 | } 216 | 217 | return xReturn; 218 | } 219 | /*-----------------------------------------------------------*/ 220 | 221 | char *FreeRTOS_CLIGetOutputBuffer( void ) 222 | { 223 | return cOutputBuffer; 224 | } 225 | /*-----------------------------------------------------------*/ 226 | 227 | const char *FreeRTOS_CLIGetParameter( const char *pcCommandString, UBaseType_t uxWantedParameter, BaseType_t *pxParameterStringLength ) 228 | { 229 | UBaseType_t uxParametersFound = 0; 230 | const char *pcReturn = NULL; 231 | 232 | *pxParameterStringLength = 0; 233 | 234 | while( uxParametersFound < uxWantedParameter ) 235 | { 236 | /* Index the character pointer past the current word. If this is the start 237 | of the command string then the first word is the command itself. */ 238 | while( ( ( *pcCommandString ) != 0x00 ) && ( ( *pcCommandString ) != ' ' ) ) 239 | { 240 | pcCommandString++; 241 | } 242 | 243 | /* Find the start of the next string. */ 244 | while( ( ( *pcCommandString ) != 0x00 ) && ( ( *pcCommandString ) == ' ' ) ) 245 | { 246 | pcCommandString++; 247 | } 248 | 249 | /* Was a string found? */ 250 | if( *pcCommandString != 0x00 ) 251 | { 252 | /* Is this the start of the required parameter? */ 253 | uxParametersFound++; 254 | 255 | if( uxParametersFound == uxWantedParameter ) 256 | { 257 | /* How long is the parameter? */ 258 | pcReturn = pcCommandString; 259 | while( ( ( *pcCommandString ) != 0x00 ) && ( ( *pcCommandString ) != ' ' ) ) 260 | { 261 | ( *pxParameterStringLength )++; 262 | pcCommandString++; 263 | } 264 | 265 | if( *pxParameterStringLength == 0 ) 266 | { 267 | pcReturn = NULL; 268 | } 269 | 270 | break; 271 | } 272 | } 273 | else 274 | { 275 | break; 276 | } 277 | } 278 | 279 | return pcReturn; 280 | } 281 | /*-----------------------------------------------------------*/ 282 | 283 | static BaseType_t prvHelpCommand( char *pcWriteBuffer, size_t xWriteBufferLen, const char *pcCommandString ) 284 | { 285 | static const CLI_Definition_List_Item_t * pxCommand = NULL; 286 | BaseType_t xReturn; 287 | 288 | ( void ) pcCommandString; 289 | 290 | if( pxCommand == NULL ) 291 | { 292 | /* Reset the pxCommand pointer back to the start of the list. */ 293 | pxCommand = &xRegisteredCommands; 294 | } 295 | 296 | /* Return the next command help string, before moving the pointer on to 297 | the next command in the list. */ 298 | strncpy( pcWriteBuffer, pxCommand->pxCommandLineDefinition->pcHelpString, xWriteBufferLen ); 299 | pxCommand = pxCommand->pxNext; 300 | 301 | if( pxCommand == NULL ) 302 | { 303 | /* There are no more commands in the list, so there will be no more 304 | strings to return after this one and pdFALSE should be returned. */ 305 | xReturn = pdFALSE; 306 | } 307 | else 308 | { 309 | xReturn = pdTRUE; 310 | } 311 | 312 | return xReturn; 313 | } 314 | /*-----------------------------------------------------------*/ 315 | 316 | static int8_t prvGetNumberOfParameters( const char *pcCommandString ) 317 | { 318 | int8_t cParameters = 0; 319 | BaseType_t xLastCharacterWasSpace = pdFALSE; 320 | 321 | /* Count the number of space delimited words in pcCommandString. */ 322 | while( *pcCommandString != 0x00 ) 323 | { 324 | if( ( *pcCommandString ) == ' ' ) 325 | { 326 | if( xLastCharacterWasSpace != pdTRUE ) 327 | { 328 | cParameters++; 329 | xLastCharacterWasSpace = pdTRUE; 330 | } 331 | } 332 | else 333 | { 334 | xLastCharacterWasSpace = pdFALSE; 335 | } 336 | 337 | pcCommandString++; 338 | } 339 | 340 | /* If the command string ended with spaces, then there will have been too 341 | many parameters counted. */ 342 | if( xLastCharacterWasSpace == pdTRUE ) 343 | { 344 | cParameters--; 345 | } 346 | 347 | /* The value returned is one less than the number of space delimited words, 348 | as the first word should be the command itself. */ 349 | return cParameters; 350 | } 351 | 352 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------