eba9c15746
The patch adjust the code of the base, base-<kernel>, and os repository.
To adapt existing components to fix violations of the best practices
suggested by "Effective C++" as reported by the -Weffc++ compiler
argument. The changes follow the patterns outlined below:
* A class with virtual functions can no longer publicly inherit base
classed without a vtable. The inherited object may either be moved
to a member variable, or inherited privately. The latter would be
used for classes that inherit 'List::Element' or 'Avl_node'. In order
to enable the 'List' and 'Avl_tree' to access the meta data, the
'List' must become a friend.
* Instead of adding a virtual destructor to abstract base classes,
we inherit the new 'Interface' class, which contains a virtual
destructor. This way, single-line abstract base classes can stay
as compact as they are now. The 'Interface' utility resides in
base/include/util/interface.h.
* With the new warnings enabled, all member variables must be explicitly
initialized. Basic types may be initialized with '='. All other types
are initialized with braces '{ ... }' or as class initializers. If
basic types and non-basic types appear in a row, it is nice to only
use the brace syntax (also for basic types) and align the braces.
* If a class contains pointers as members, it must now also provide a
copy constructor and assignment operator. In the most cases, one
would make them private, effectively disallowing the objects to be
copied. Unfortunately, this warning cannot be fixed be inheriting
our existing 'Noncopyable' class (the compiler fails to detect that
the inheriting class cannot be copied and still gives the error).
For now, we have to manually add declarations for both the copy
constructor and assignment operator as private class members. Those
declarations should be prepended with a comment like this:
/*
* Noncopyable
*/
Thread(Thread const &);
Thread &operator = (Thread const &);
In the future, we should revisit these places and try to replace
the pointers with references. In the presence of at least one
reference member, the compiler would no longer implicitly generate
a copy constructor. So we could remove the manual declaration.
Issue #465
136 lines
2.7 KiB
C++
136 lines
2.7 KiB
C++
/*
|
|
* \brief UART driver interface
|
|
* \author Christian Helmuth
|
|
* \author Stefan Kalkowski
|
|
* \date 2011-05-30
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2011-2017 Genode Labs GmbH
|
|
*
|
|
* This file is part of the Genode OS framework, which is distributed
|
|
* under the terms of the GNU Affero General Public License version 3.
|
|
*/
|
|
|
|
#ifndef _UART_DRIVER_BASE_H_
|
|
#define _UART_DRIVER_BASE_H_
|
|
|
|
#include <irq_session/connection.h>
|
|
|
|
namespace Uart {
|
|
class Driver_base;
|
|
class Driver;
|
|
struct Driver_factory;
|
|
struct Char_avail_functor;
|
|
};
|
|
|
|
|
|
/**
|
|
* Functor, called by 'Driver' when data is ready for reading
|
|
*/
|
|
struct Uart::Char_avail_functor
|
|
{
|
|
Genode::Signal_context_capability sigh;
|
|
|
|
void operator ()() {
|
|
if (sigh.valid()) Genode::Signal_transmitter(sigh).submit(); }
|
|
|
|
};
|
|
|
|
|
|
class Uart::Driver_base
|
|
{
|
|
private:
|
|
|
|
Char_avail_functor &_char_avail;
|
|
Genode::Irq_connection _irq;
|
|
Genode::Signal_handler<Driver_base> _irq_handler;
|
|
|
|
public:
|
|
|
|
Driver_base(Genode::Env &env, int irq_number, Char_avail_functor &func)
|
|
: _char_avail(func),
|
|
_irq(env, irq_number),
|
|
_irq_handler(env.ep(), *this, &Driver_base::handle_irq)
|
|
{
|
|
_irq.sigh(_irq_handler);
|
|
_irq.ack_irq();
|
|
}
|
|
|
|
virtual ~Driver_base() {}
|
|
|
|
/**
|
|
* Handle interrupt
|
|
*/
|
|
virtual void handle_irq()
|
|
{
|
|
_char_avail();
|
|
_irq.ack_irq();
|
|
}
|
|
|
|
/**
|
|
* 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 baud)
|
|
{
|
|
Genode::warning("Setting baudrate to ", baud,
|
|
" is not supported. Use default value.");
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Interface for constructing the driver objects
|
|
*/
|
|
struct Uart::Driver_factory
|
|
{
|
|
struct Not_available { };
|
|
|
|
Genode::Env &env;
|
|
Genode::Heap &heap;
|
|
Driver *drivers[UARTS_NUM];
|
|
|
|
Driver_factory(Genode::Env &env, Genode::Heap &heap)
|
|
: env(env), heap(heap) {
|
|
for (unsigned i = 0; i < UARTS_NUM; i++) drivers[i] = 0; }
|
|
|
|
/**
|
|
* Construct new driver
|
|
*
|
|
* \param index index of UART to access
|
|
* \param baudrate baudrate of UART
|
|
* \param functor 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.
|
|
*/
|
|
Driver &create(unsigned index, unsigned baudrate,
|
|
Char_avail_functor &functor);
|
|
|
|
/**
|
|
* Destroy driver
|
|
*/
|
|
void destroy(Driver &) { /* TODO */ }
|
|
};
|
|
|
|
#endif /* _UART_DRIVER_BASE_H_ */
|