genode/repos/os/src/drivers/uart/uart_driver.h
Norman Feske 17c79a9e23 base: avoid use of deprecated base/printf.h
Besides adapting the components to the use of base/log.h, the patch
cleans up a few base headers, i.e., it removes unused includes from
root/component.h, specifically base/heap.h and
ram_session/ram_session.h. Hence, components that relied on the implicit
inclusion of those headers have to manually include those headers now.

While adjusting the log messages, I repeatedly stumbled over the problem
that printing char * arguments is ambiguous. It is unclear whether to
print the argument as pointer or null-terminated string. To overcome
this problem, the patch introduces a new type 'Cstring' that allows the
caller to express that the argument should be handled as null-terminated
string. As a nice side effect, with this type in place, the optional len
argument of the 'String' class could be removed. Instead of supplying a
pair of (char const *, size_t), the constructor accepts a 'Cstring'.
This, in turn, clears the way let the 'String' constructor use the new
output mechanism to assemble a string from multiple arguments (and
thereby getting rid of snprintf within Genode in the near future).

To enforce the explicit resolution of the char * ambiguity, the 'char *'
overload of the 'print' function is marked as deleted.

Issue #1987
2016-08-29 17:27:10 +02:00

85 lines
1.7 KiB
C++

/*
* \brief UART driver interface
* \author Christian Helmuth
* \date 2011-05-30
*/
/*
* Copyright (C) 2011-2013 Genode Labs GmbH
*
* This file is part of the Genode OS framework, which is distributed
* under the terms of the GNU General Public License version 2.
*/
#ifndef _UART_DRIVER_H_
#define _UART_DRIVER_H_
namespace Uart {
/**
* Functor, called by 'Driver' when data is ready for reading
*/
struct Char_avail_callback
{
virtual void operator()() { }
};
struct Driver
{
/**
* Write character to UART
*/
virtual void put_char(char c) = 0;
/**
* Return true if character is available for reading
*/
virtual bool char_avail() = 0;
/**
* Read character from UART
*/
virtual char get_char() = 0;
/**
* Set baud rate for terminal
*/
virtual void baud_rate(int /*bits_per_second*/)
{
Genode::warning("Setting baudrate is not supported yet. Use default 115200.");
}
};
/**
* Interface for constructing the driver objects
*/
struct Driver_factory
{
struct Not_available { };
/**
* Construct new driver
*
* \param index index of UART to access
* \param baudrate baudrate of UART
* \param callback functor called when data becomes available for
* reading
*
* \throws Uart_not_available
*
* Note that the 'callback' is called in the context of the IRQ
* handler. Hence, the operations performed by the registered
* function must be properly synchronized.
*/
virtual Driver *create(unsigned index, unsigned baudrate, Char_avail_callback &callback) = 0;
/**
* Destroy driver
*/
virtual void destroy(Driver *driver) = 0;
};
}
#endif /* _UART_DRIVER_H_ */