110 lines
2.6 KiB
C++
110 lines
2.6 KiB
C++
/*
|
|
* \brief Interfaces used internally in NIC drivers
|
|
* \author Norman Feske
|
|
* \date 2011-05-21
|
|
*/
|
|
|
|
/*
|
|
* 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 _INCLUDE__NIC__DRIVER_H_
|
|
#define _INCLUDE__NIC__DRIVER_H_
|
|
|
|
#include <os/irq_activation.h> /* for 'Genode::Irq_handler' type */
|
|
#include <nic_session/nic_session.h> /* for 'Nic::Mac_address' type */
|
|
|
|
namespace Nic {
|
|
|
|
struct Rx_buffer_alloc;
|
|
struct Driver;
|
|
struct Driver_factory;
|
|
struct Driver_notification;
|
|
}
|
|
|
|
|
|
/**
|
|
* Interface for allocating the backing store for incoming packets
|
|
*/
|
|
struct Nic::Rx_buffer_alloc
|
|
{
|
|
/**
|
|
* Allocate packet buffer
|
|
*/
|
|
virtual void *alloc(Genode::size_t) = 0;
|
|
|
|
/**
|
|
* Submit packet to client
|
|
*/
|
|
virtual void submit() = 0;
|
|
};
|
|
|
|
|
|
/**
|
|
* Interface for driver-to-component notifications
|
|
*/
|
|
struct Nic::Driver_notification { virtual void link_state_changed() = 0; };
|
|
|
|
|
|
/**
|
|
* Interface to be implemented by the device-specific driver code
|
|
*/
|
|
struct Nic::Driver : Genode::Irq_handler
|
|
{
|
|
/**
|
|
* Return MAC address of the network interface
|
|
*/
|
|
virtual Mac_address mac_address() = 0;
|
|
|
|
/**
|
|
* Return link state (true if link detected)
|
|
*/
|
|
virtual bool link_state() = 0;
|
|
|
|
/**
|
|
* Transmit packet
|
|
*
|
|
* \param packet start of packet
|
|
* \param size packet size
|
|
*
|
|
* If the packet size is not a multiple of 4 bytes, this method
|
|
* accesses the bytes after the packet buffer up to the next 4-byte
|
|
* length (in the worst case, 3 bytes after the packet end).
|
|
*/
|
|
virtual void tx(char const *packet, Genode::size_t size) = 0;
|
|
};
|
|
|
|
|
|
/**
|
|
* Interface for constructing the driver object
|
|
*
|
|
* The driver object requires an rx-packet allocator at construction time.
|
|
* This allocator, however, exists not before the creation of a NIC session
|
|
* because the client pays for it. Therefore, the driver must be created at
|
|
* session-construction time. Because drivers may differ with regard to
|
|
* their constructor arguments, the 'Driver_factory' interface allows for
|
|
* unifying the session-creation among these drivers.
|
|
*/
|
|
struct Nic::Driver_factory
|
|
{
|
|
/**
|
|
* Construct new driver
|
|
*
|
|
* \param rx_buffer_alloc buffer allocator used for storing incoming
|
|
* packets
|
|
* \param notifier callback for notifications
|
|
*/
|
|
virtual Driver *create(Rx_buffer_alloc &rx_buffer_alloc,
|
|
Driver_notification ¬ify) = 0;
|
|
|
|
/**
|
|
* Destroy driver
|
|
*/
|
|
virtual void destroy(Driver *driver) = 0;
|
|
};
|
|
|
|
#endif /* _INCLUDE__NIC__DRIVER_H_ */
|