aboutsummaryrefslogtreecommitdiff
path: root/debugger
AgeCommit message (Collapse)Author
2020-10-02docs: Prefer `\` to `@` in Doxygen commentsChris Kay
This commit replaces any instances of `@`-style Doxygen commands with their `\`-style equivalents. This is done for consistency across the codebase. The `\sa` Doxygen command has been added to the Clang-Format configuration to prevent it from reflowing see-also comments, which often exceed the column limit due to referring to long URLs. Change-Id: Ia4ebe8bd310293da9e2af55fe253f0762807e88a Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-10-02docs: Ensure Doxygen return values use referencesChris Kay
At present a lot of the code-base uses `\retval` commands to framework status codes but does not explicitly link to them. In some cases it's necessary to explicitly link to these status codes to have Doxygen generate a link to the relevant enumeration, and we can do this by prefixing the name with `::`. This style is already used in much of the code-base, so should not conflict with any existing styles. Change-Id: Ifc78eb425981bee3a01c791757a41a61c20e636c Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-09-08cli: Remove dependencies on UART implementationChris Kay
With the introduction of the I/O framework component, the CLI can now refer to a standard output configured by the firmware for sending and receiving UART data. This patch therefore moves any CLI-specific UART platform interfaces to the I/O component with the standard input and output streams. Change-Id: Iac55f592b438a603193da568e16eaf39fca115cf Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-08-28fwk: Add compiler attribute macrosChris Kay
Some attributes are not available on all the toolchains we support. We need to have the ability to conditionally remove macros and hide the attribute syntax from the user for attributes that are not universally supported. This commit adds a macro alternative to all currently used attributes within the project to date. Change-Id: Ibf84bc8d0dc941c9db2f946e4ac20dd5bf44bf24 Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-06-09misc: Switch from ISO C11 to GNU C11Chris Kay
We use a number of compiler extensions already, and the strict rules required for compliance with ISO C11 can be prohitive for embedded development. This commit moves our C variant from ISO C11 to GNU C11, which is compatible with all the toolchains we currently support. Change-Id: I58ce6479c4f8ca9039d957d08aadd3ebff4ac8fc Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-05-22dbg: Fix the compile error when DEBUGGER flag setJagadeesh Ujja
This patch fixes the compile error seen when DEBUGGER flag is set Change-Id: Ie9395eabf7b849cb43c2245cea3698bf916b915d Signed-off-by: Jagadeeesh Ujja <jagadeesh.ujja@arm.com>
2020-04-21misc: Fix code style errorChris Kay
This commit fixes a syntax error mistakenly flagged up by the coding style script. Change-Id: Ie13a5d53eeb732b5e4ef489f61d5627b800b725c Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-03-24misc: Clean up include directivesChris Kay
This commit cleans up include directives across the project to reduce the number of implicit transitive dependencies in preparation for mass header changes in the logging patches later on. These changes were made using two tools: clang-include-fixer and include-what-you-use, which identify and remove headers that are unnecessary, and insert headers which are used but not referenced. Some manual tweaking was involved to handle special cases, like #ifdef'd includes. Includes have also been reordered and categorized according to their project locality, and non-module includes now use quotes rather than angle brackets. Change-Id: Id39dc473f44b73cb98f3b8949f9e768fd2ace6cd Signed-off-by: Chris Kay <chris.kay@arm.com>
2020-03-23dbg: Replace checkpoint functionality with empty calls when flag is offAnthony Roberts
This allows CLI functions such as checkpoint() to be left in the code without having them behind an ifdef. Change-Id: I8680ef5cdd0ae126b41a059ca6219dd4f1674f92 Signed-off-by: Anthony Roberts <anthony.roberts@arm.com>
2020-03-23dbg: Fix the CLI print text colorTarek El-Sherbiny
This patch is to fix the text color format Change-Id: Iaf7633f102f9f6e1e5385eab4322be530ac38413 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Update the documentationTarek El-Sherbiny
This patch updates the documentation according to the current implementation. Change-Id: If965bd2060678466979252f86e5c45dfa3d07819 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: CLI command history bufferTarek El-Sherbiny
The cli commands history buffer is cleared every time the cli is called. For example, when using a checkpoint to invoke the cli the history buffer will be empty. This patch maintains the history buffer between cli calls. Change-Id: I763bf8d6bb9128c93c641943c85043ebf1f4e425 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Add check for duplicate commandsTarek El-Sherbiny
It is required to avoid registering the same cli command multiple times if the registration function was called with the same parameters. This change compares the new command name against all existing commands and ignores the request if the same name was used. Change-Id: Ia3271bd1bcc3a33ad7b751af00a97dec49fd2340 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Fix the backspace functionTarek El-Sherbiny
Pressing backspace in the CLI does not work. The current method is not using a standard ANSI escape code. This patch solves the problem. Change-Id: I02a1d09628c3df5b96c5561d846dc35d579e179c Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Update CLI checkpoint commandsTarek El-Sherbiny
This patch adds two new commands to enable and disable checkpoints for each registration individually. Change-Id: I5a6a1b53f2dcd91754be6b29caf76464f9e150ec Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Convert the cli commands array to a linked listTarek El-Sherbiny
This patch gives the ability to add new cli commands at run time. Any new command can be added by calling the cli_dbg_register_command function after filling the command struct members accordingly. The new command will be added to the commands linked list. At startup, only the common cli commands will be available to the user. Any additional command must be register to be available in the cli. Change-Id: Ib81a70f4f7737050d0ea02692b0ef34773e25c8b Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Add CLI exit sequenceTarek El-Sherbiny
Ctrl+d sequence will exit the CLI and resume normal operation. Change-Id: I8465d218c7a445242d3a207373359f6ecbc1f2f4 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Enable CLI checkpoint commandsTarek El-Sherbiny
This patch enables the CLI checkpoint commands Change-Id: I29fc07bebcdfcd019325e3fd453eb3d20393b05e Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Add checkpoint implementationTarek El-Sherbiny
This patch adds the main checkpoint APIs Change-Id: I73efaba8a5e95286abf961d2f0fb395dfec69d59 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Compile in cli fifo and cli time filesTarek El-Sherbiny
The cli is using fifo and time functions internally. This patch compiles the required c files. Change-Id: I9d36b75b9e5c847c7a4547a61be705f08e0fa301 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>
2020-03-23dbg: Import the CLI codeTarek El-Sherbiny
This patch imports existing CLI implementaion. Change-Id: I65c79811e90f866980ded22dde82fbfe3c01f853 Signed-off-by: Tarek El-Sherbiny <tarek.el-sherbiny@arm.com>