Skip to content

Add set_baud() method to UARTSerial(). #4615

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.

Sign up for GitHub

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 1 commit into from
Jul 24, 2017
Merged

Add set_baud() method to UARTSerial(). #4615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions drivers/UARTSerial.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ void UARTSerial::dcd_irq()
wake();
}

void UARTSerial::set_baud(int baud)
{
SerialBase::baud(baud);
}

void UARTSerial::set_data_carrier_detect(PinName dcd_pin, bool active_high)
{
delete _dcd_irq;
Expand Down
6 changes: 6 additions & 0 deletions drivers/UARTSerial.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,12 @@ class UARTSerial : private SerialBase, public FileHandle {
*/
void set_data_carrier_detect(PinName dcd_pin, bool active_high = false);

/** Set the baud rate
*
* @param baud The baud rate
*/
void set_baud(int baud);
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you use the baud method from SerialBase instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kjbracey-arm: Kevin, are you OK with the convention of simply calling in the SerialBase method rather than having the intermediate that adds 'set_'?

Copy link
Contributor

Choose a reason for hiding this comment

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

The question is why SerialBase is inherited privately?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

A philosophical/religious question for @kjbracey-arm I think...

Copy link
Contributor

@kjbracey kjbracey Jul 12, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

It's private because if any user messes with the underlying port while we're using it, it could break us - at least if they go anywhere near the core data functions.

This is a driver that uses the underlying serial port itself - I don't want to expose it to the users of this class so they can freely touch it. Making it a public base class would expose more than I want.

In this particular case "baud" could directly pass through, as we don't care (beyond maybe it being a good idea to drain the output buffer?).

But "set_flow_control" we would potentially want to implement ourself rather than pass through to provide XON/XOFF or manual HW control.

There's existing inconsistency on the "set_" prefix ("baud" vs "set_flow_control"), so it seems reasonable to unify on the "set_" to me.

General note - we are currently lacking is a "serial control" abstract interface for these things (baud, format, flow control, hup) - each of the buffered serial, the raw serial, and the serial mux should all be providing that as a common interface.

Copy link
Contributor

Choose a reason for hiding this comment

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

There's existing inconsistency on the "set_" prefix ("baud" vs "set_flow_control"), so it seems reasonable to unify on the "set_" to me.

General note - we are currently lacking is a "serial control" abstract interface for these things (baud, format, flow control, hup) - each of the buffered serial, the raw serial, and the serial mux should all be providing that as a common interface.

+1

Thanks for the explanation @kjbracey-arm


private:

/** Software serial buffers
Expand Down