mirror of
https://github.com/RGBCube/serenity
synced 2025-05-19 23:05:07 +00:00
05ba034000
This class is intended to replace all IOAddress usages in the Kernel
codebase altogether. The idea is to ensure IO can be done in
arch-specific manner that is determined mostly in compile-time, but to
still be able to use most of the Kernel code in non-x86 builds. Specific
devices that rely on x86-specific IO instructions are already placed in
the Arch/x86 directory and are omitted for non-x86 builds.
The reason this works so well is the fact that x86 IO space acts in a
similar fashion to the traditional memory space being available in most
CPU architectures - the x86 IO space is essentially just an array of
bytes like the physical memory address space, but requires x86 IO
instructions to load and store data. Therefore, many devices allow host
software to interact with the hardware registers in both ways, with a
noticeable trend even in the modern x86 hardware to move away from the
old x86 IO space to exclusively using memory-mapped IO.
Therefore, the IOWindow class encapsulates both methods for x86 builds.
The idea is to allow PCI devices to be used in either way in x86 builds,
so when trying to map an IOWindow on a PCI BAR, the Kernel will try to
find the proper method being declared with the PCI BAR flags.
For old PCI hardware on non-x86 builds this might turn into a problem as
we can't use port mapped IO, so the Kernel will gracefully fail with
ENOTSUP error code if that's the case, as there's really nothing we can
do within such case.
For general IO, the read{8,16,32} and write{8,16,32} methods are
available as a convenient API for other places in the Kernel. There are
simply no direct 64-bit IO API methods yet, as it's not needed right now
and is not considered to be Arch-agnostic too - the x86 IO space doesn't
support generating 64 bit cycle on IO bus and instead requires two 2
32-bit accesses. If for whatever reason it appears to be necessary to do
IO in such manner, it could probably be added with some neat tricks to
do so. It is recommended to use Memory::TypedMapping struct if direct 64
bit IO is actually needed.
99 lines
2.9 KiB
C++
99 lines
2.9 KiB
C++
/*
|
|
* Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <AK/OwnPtr.h>
|
|
#include <Kernel/Bus/PCI/Access.h>
|
|
#include <Kernel/Bus/PCI/Device.h>
|
|
#include <Kernel/IOWindow.h>
|
|
#include <Kernel/Interrupts/IRQHandler.h>
|
|
#include <Kernel/Net/NetworkAdapter.h>
|
|
#include <Kernel/Random.h>
|
|
|
|
namespace Kernel {
|
|
|
|
class E1000NetworkAdapter : public NetworkAdapter
|
|
, public PCI::Device
|
|
, public IRQHandler {
|
|
public:
|
|
static LockRefPtr<E1000NetworkAdapter> try_to_initialize(PCI::DeviceIdentifier const&);
|
|
|
|
virtual bool initialize();
|
|
|
|
virtual ~E1000NetworkAdapter() override;
|
|
|
|
virtual void send_raw(ReadonlyBytes) override;
|
|
virtual bool link_up() override { return m_link_up; };
|
|
virtual i32 link_speed() override;
|
|
virtual bool link_full_duplex() override;
|
|
|
|
virtual StringView purpose() const override { return class_name(); }
|
|
|
|
protected:
|
|
void setup_interrupts();
|
|
void setup_link();
|
|
|
|
E1000NetworkAdapter(PCI::Address, u8 irq, NonnullOwnPtr<IOWindow> registers_io_window, NonnullOwnPtr<KString>);
|
|
virtual bool handle_irq(RegisterState const&) override;
|
|
virtual StringView class_name() const override { return "E1000NetworkAdapter"sv; }
|
|
|
|
struct [[gnu::packed]] e1000_rx_desc {
|
|
volatile uint64_t addr { 0 };
|
|
volatile uint16_t length { 0 };
|
|
volatile uint16_t checksum { 0 };
|
|
volatile uint8_t status { 0 };
|
|
volatile uint8_t errors { 0 };
|
|
volatile uint16_t special { 0 };
|
|
};
|
|
|
|
struct [[gnu::packed]] e1000_tx_desc {
|
|
volatile uint64_t addr { 0 };
|
|
volatile uint16_t length { 0 };
|
|
volatile uint8_t cso { 0 };
|
|
volatile uint8_t cmd { 0 };
|
|
volatile uint8_t status { 0 };
|
|
volatile uint8_t css { 0 };
|
|
volatile uint16_t special { 0 };
|
|
};
|
|
|
|
virtual void detect_eeprom();
|
|
virtual u32 read_eeprom(u8 address);
|
|
void read_mac_address();
|
|
|
|
void write_command(u16 address, u32);
|
|
u32 read_command(u16 address);
|
|
|
|
void initialize_rx_descriptors();
|
|
void initialize_tx_descriptors();
|
|
|
|
void out8(u16 address, u8);
|
|
void out16(u16 address, u16);
|
|
void out32(u16 address, u32);
|
|
u8 in8(u16 address);
|
|
u16 in16(u16 address);
|
|
u32 in32(u16 address);
|
|
|
|
void receive();
|
|
|
|
static constexpr size_t number_of_rx_descriptors = 256;
|
|
static constexpr size_t number_of_tx_descriptors = 256;
|
|
|
|
NonnullOwnPtr<IOWindow> m_registers_io_window;
|
|
|
|
OwnPtr<Memory::Region> m_rx_descriptors_region;
|
|
OwnPtr<Memory::Region> m_tx_descriptors_region;
|
|
OwnPtr<Memory::Region> m_rx_buffer_region;
|
|
OwnPtr<Memory::Region> m_tx_buffer_region;
|
|
Array<void*, number_of_rx_descriptors> m_rx_buffers;
|
|
Array<void*, number_of_tx_descriptors> m_tx_buffers;
|
|
bool m_has_eeprom { false };
|
|
bool m_link_up { false };
|
|
EntropySource m_entropy_source;
|
|
|
|
WaitQueue m_wait_queue;
|
|
};
|
|
}
|