2016-08-23 15:36:06 +02:00
|
|
|
/*
|
|
|
|
* \brief Driver for OMAP4 UARTs
|
|
|
|
* \author Ivan Loskutov
|
|
|
|
* \author Stefan Kalkowski
|
|
|
|
* \date 2012-11-08
|
|
|
|
*/
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Copyright (C) 2012 Ksys Labs LLC
|
2017-02-20 13:23:52 +01:00
|
|
|
* Copyright (C) 2011-2017 Genode Labs GmbH
|
2016-08-23 15:36:06 +02:00
|
|
|
*
|
|
|
|
* This file is part of the Genode OS framework, which is distributed
|
2017-02-20 13:23:52 +01:00
|
|
|
* under the terms of the GNU Affero General Public License version 3.
|
2016-08-23 15:36:06 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _UART_DRIVER_H_
|
|
|
|
#define _UART_DRIVER_H_
|
|
|
|
|
|
|
|
/* Genode includes */
|
|
|
|
#include <base/attached_io_mem_dataspace.h>
|
|
|
|
#include <base/env.h>
|
2017-04-28 15:27:26 +02:00
|
|
|
#include <drivers/defs/panda.h>
|
|
|
|
#include <drivers/uart/tl16c750.h>
|
2016-08-23 15:36:06 +02:00
|
|
|
|
|
|
|
enum { UARTS_NUM = 4 }; /* needed by base class definitions */
|
|
|
|
|
|
|
|
/* local includes */
|
|
|
|
#include <uart_driver_base.h>
|
|
|
|
|
Follow practices suggested by "Effective C++"
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
2017-12-21 15:42:15 +01:00
|
|
|
class Uart::Driver : private Genode::Attached_io_mem_dataspace,
|
|
|
|
private Genode::Tl16c750_uart,
|
|
|
|
public Uart::Driver_base
|
2016-08-23 15:36:06 +02:00
|
|
|
{
|
|
|
|
private:
|
|
|
|
|
|
|
|
void _enable_rx_interrupt()
|
|
|
|
{
|
|
|
|
/* enable access to 'Uart_fcr' and 'Uart_ier' */
|
|
|
|
write<Uart_lcr::Reg_mode>(Uart_lcr::Reg_mode::OPERATIONAL);
|
|
|
|
|
|
|
|
/* enable rx interrupt, disable other interrupts and sleep mode */
|
|
|
|
write<Uart_ier>(Uart_ier::Rhr_it::bits(1)
|
|
|
|
| Uart_ier::Thr_it::bits(0)
|
|
|
|
| Uart_ier::Line_sts_it::bits(0)
|
|
|
|
| Uart_ier::Modem_sts_it::bits(0)
|
|
|
|
| Uart_ier::Sleep_mode::bits(0)
|
|
|
|
| Uart_ier::Xoff_it::bits(0)
|
|
|
|
| Uart_ier::Rts_it::bits(0)
|
|
|
|
| Uart_ier::Cts_it::bits(0));
|
|
|
|
/*
|
|
|
|
* Configure protocol formatting and thereby return to
|
|
|
|
* operational mode.
|
|
|
|
*/
|
|
|
|
write<Uart_lcr>(Uart_lcr::Char_length::bits(Uart_lcr::Char_length::_8_BIT)
|
|
|
|
| Uart_lcr::Nb_stop::bits(Uart_lcr::Nb_stop::_1_STOP_BIT)
|
|
|
|
| Uart_lcr::Parity_en::bits(0)
|
|
|
|
| Uart_lcr::Break_en::bits(0)
|
|
|
|
| Uart_lcr::Div_en::bits(0));
|
|
|
|
}
|
|
|
|
|
|
|
|
enum { BAUD_115200 = 115200 };
|
|
|
|
|
|
|
|
struct Uart {
|
|
|
|
Genode::addr_t mmio_base;
|
|
|
|
Genode::size_t mmio_size;
|
|
|
|
int irq_number;
|
|
|
|
};
|
|
|
|
|
|
|
|
Uart & _config(unsigned index)
|
|
|
|
{
|
|
|
|
using namespace Genode;
|
|
|
|
|
|
|
|
static Uart cfg[UARTS_NUM] = {
|
2017-04-28 15:27:26 +02:00
|
|
|
{ Panda::TL16C750_1_MMIO_BASE, Panda::TL16C750_MMIO_SIZE,
|
|
|
|
Panda::TL16C750_1_IRQ },
|
|
|
|
{ Panda::TL16C750_2_MMIO_BASE, Panda::TL16C750_MMIO_SIZE,
|
|
|
|
Panda::TL16C750_2_IRQ },
|
|
|
|
{ Panda::TL16C750_3_MMIO_BASE, Panda::TL16C750_MMIO_SIZE,
|
|
|
|
Panda::TL16C750_3_IRQ },
|
|
|
|
{ Panda::TL16C750_4_MMIO_BASE, Panda::TL16C750_MMIO_SIZE,
|
|
|
|
Panda::TL16C750_4_IRQ },
|
2016-08-23 15:36:06 +02:00
|
|
|
};
|
|
|
|
return cfg[index];
|
|
|
|
}
|
|
|
|
|
|
|
|
unsigned _baud_rate(unsigned baud_rate)
|
|
|
|
{
|
|
|
|
if (baud_rate != 0) return baud_rate;
|
|
|
|
|
|
|
|
Genode::warning("baud_rate ", baud_rate,
|
|
|
|
" not supported, set to default");
|
|
|
|
return BAUD_115200;
|
|
|
|
}
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
|
|
|
Driver(Genode::Env &env, unsigned index,
|
|
|
|
unsigned baud_rate, Char_avail_functor &func)
|
|
|
|
: Genode::Attached_io_mem_dataspace(env, _config(index).mmio_base,
|
|
|
|
_config(index).mmio_size),
|
2017-04-28 15:27:26 +02:00
|
|
|
Tl16c750_uart((Genode::addr_t)local_addr<void>(),
|
|
|
|
Panda::TL16C750_CLOCK,
|
2016-08-23 15:36:06 +02:00
|
|
|
_baud_rate(baud_rate)),
|
|
|
|
Driver_base(env, _config(index).irq_number, func) {
|
|
|
|
_enable_rx_interrupt(); }
|
|
|
|
|
|
|
|
|
|
|
|
/***************************
|
|
|
|
** UART driver interface **
|
|
|
|
***************************/
|
|
|
|
|
|
|
|
void handle_irq() override
|
|
|
|
{
|
|
|
|
/* check for interrupt */
|
|
|
|
unsigned int iir = read<Uart_iir::It_pending>();
|
|
|
|
if (iir) return;
|
|
|
|
|
|
|
|
/* inform client about the availability of data */
|
|
|
|
Driver_base::handle_irq();
|
|
|
|
}
|
|
|
|
|
2017-04-28 15:27:26 +02:00
|
|
|
void put_char(char c) override { Tl16c750_uart::put_char(c); }
|
2016-08-23 15:36:06 +02:00
|
|
|
|
|
|
|
bool char_avail() override { return read<Uart_lsr::Rx_fifo_empty>(); }
|
|
|
|
|
|
|
|
char get_char() override { return read<Uart_rhr::Rhr>(); }
|
|
|
|
|
|
|
|
void baud_rate(int bits_per_second) override
|
|
|
|
{
|
2017-04-28 15:27:26 +02:00
|
|
|
_init(Panda::TL16C750_CLOCK, bits_per_second);
|
2016-08-23 15:36:06 +02:00
|
|
|
_enable_rx_interrupt();
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /* _UART_DRIVER_H_ */
|