Skip to content

Add semihosting and SWO examples to mbed_override_console(). #10553

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2019

Conversation

korjaa
Copy link
Contributor

@korjaa korjaa commented May 10, 2019

Description

Add semihosting and SWO examples to mbed_override_console().

Pull request type

[ ] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[x] Docs update
[ ] Test update
[ ] Breaking change

Reviewers

@kjbracey-arm

Release Notes

@korjaa
Copy link
Contributor Author

korjaa commented May 10, 2019

@TeroJaasko, here's the header update you suggested.

@korjaa korjaa force-pushed the semihosting_docs branch from a6b8e58 to 3546a60 Compare May 10, 2019 06:15
@korjaa
Copy link
Contributor Author

korjaa commented May 10, 2019

Added missing @endcode tags.

@ciarmcom ciarmcom requested review from kjbracey and a team May 10, 2019 07:00
@ciarmcom
Copy link
Member

@korjaa, thank you for your changes.
@kjbracey-arm @ARMmbed/mbed-os-core @ARMmbed/mbed-os-maintainers please review.

@korjaa korjaa force-pushed the semihosting_docs branch from 3546a60 to a48d126 Compare May 10, 2019 07:05
@korjaa
Copy link
Contributor Author

korjaa commented May 10, 2019

Add missing fileno parameter name.

*
* Example using SingleWireOutput:
* @code
* FileHandle* mbed::mbed_override_console(int) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our coding standard changed while I was writing this in the first place, and the code got updated, but not the examples. * binds to the right. Fix the existing one too.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stars are binding to the right now.

* static LocalFileSystem fs("host");
* if (fileno == STDIN_FILENO) {
* static FileHandle *in_terminal;
* static int in_open_result = fs.open(&in_terminal, ":tt", O_RDONLY);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That code is a bit RAM-inefficient, as it has two extra "once-only" control structures, and unused open results, but it's probably the simplest way of writing it.

The following would minimise RAM usage, but rather ends up obfuscating it.:

static LocalFileSystem fs("host");
struct TerminalStream {
    TerminalStream(FileSystemHandle &fs, int flags) {
        if (fs.open(&filehandle, ":tt", flags) != 0) {
            filehandle = NULL;
        }
    }
    FileHandle *filehandle;
}
if (fileno == STDIN_FILENO) {
    static TerminalStream in_terminal(fs, O_RDONLY):
    return in_terminal.filehandle;
} else {
    static TerminalStream out_terminal(fs, O_WRONLY);
    return out_terminal.filehandle;
}

You could leave it as-is; depends whether we want a simple example or to save 16 bytes of RAM when it's copy-pasted.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another possible refinement would be to check if the debugger is attached before attempting the open (LocalFileSystem doesn't), so it doesn't crash.

semihost_connected() should tell you that in principle, but it seems that it's currently conditional on a DEVICE_DEBUG_AWARENESS that I've never heard of and is set on basically no platforms. Not sure why - it's a core CPU feature? All M-class devices should have the bit it's trying to check.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this one is so bluntly visible on the main.cpp, so maybe it would be OK to leave it as it is without the optimal memory consumption. And as you said it's a bit easier to understand.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This semihost_connected() sounds like a nice enhancement idea. Maybe this could be checked in some future commit when the DEVICE_DEBUG_AWARENESS is more common.

@bulislaw
Copy link
Member

We should have a section in our handbook about that as well.

@korjaa
Copy link
Contributor Author

korjaa commented May 13, 2019

We should have a section in our handbook about that as well.

@bulislaw You mean this one ARMmbed/mbed-os-5-docs#1063?

@0xc0170
Copy link
Contributor

0xc0170 commented May 22, 2019

@korjaa @kjbracey-arm How shall we proceed with this one, has not yet been approved.

@korjaa
Copy link
Contributor Author

korjaa commented May 23, 2019

I changed the stars and from my point of view this could be merged. @kjbracey-arm ?

@0xc0170
Copy link
Contributor

0xc0170 commented May 23, 2019

Ci started

@mbed-ci
Copy link

mbed-ci commented May 23, 2019

Test run: SUCCESS

Summary: 11 of 11 test jobs passed
Build number : 1
Build artifacts

@0xc0170 0xc0170 merged commit 541dee4 into ARMmbed:master May 23, 2019
@korjaa korjaa deleted the semihosting_docs branch May 24, 2019 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants