-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
FPGA: Device and Driver #808
base: master
Are you sure you want to change the base?
Changes from all commits
b12b45c
e178d69
dc99d8d
8ddf753
b6b255a
411234c
2f4a07b
92cb902
34eb411
80cda50
9cc48a1
9a44d4f
10f52c9
cc2f3e4
4af079a
1c8f25a
50aec3e
f7930cd
d7df428
59fcbd0
f340e15
169aa89
b537982
d5cb6e1
6c8fe65
917a01a
a056e73
503fc27
3f2870f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
/* Interface for Linux/Unix devices. | ||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#pragma once | ||
|
||
#include <filesystem> | ||
#include <optional> | ||
#include <villas/kernel/devices/driver.hpp> | ||
|
||
namespace villas { | ||
namespace kernel { | ||
namespace devices { | ||
|
||
class Device { | ||
public: | ||
virtual ~Device(){}; | ||
|
||
virtual std::optional<std::unique_ptr<Driver>> driver() const = 0; | ||
virtual std::optional<int> iommu_group() const = 0; | ||
virtual std::string name() const = 0; | ||
virtual std::filesystem::path override_path() const = 0; | ||
virtual std::filesystem::path path() const = 0; | ||
virtual void probe() const = 0; | ||
}; | ||
|
||
} // namespace devices | ||
} // namespace kernel | ||
} // namespace villas |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
/* Interface for device drivers. OS/platform independend. | ||
* Implemented for Linux/Unix drivers in linux_driver.hpp | ||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#pragma once | ||
|
||
namespace villas { | ||
namespace kernel { | ||
namespace devices { | ||
|
||
class Device; | ||
|
||
class Driver { | ||
public: | ||
virtual void attach(const Device &device) const = 0; | ||
virtual void bind(const Device &device) const = 0; | ||
virtual std::string name() const = 0; | ||
virtual void override(const Device &device) const = 0; | ||
virtual void unbind(const Device &device) const = 0; | ||
}; | ||
|
||
} // namespace devices | ||
} // namespace kernel | ||
} // namespace villas |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
/* IpDevice: Linux/Unix device which represents an IP component of a FPGA. | ||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#pragma once | ||
|
||
#include <filesystem> | ||
#include <villas/kernel/devices/platform_device.hpp> | ||
|
||
namespace villas { | ||
namespace kernel { | ||
namespace devices { | ||
|
||
class IpDevice : public PlatformDevice { | ||
public: | ||
IgnoreWarnings marked this conversation as resolved.
Show resolved
Hide resolved
|
||
static IpDevice from(const std::filesystem::path unsafe_path); | ||
static bool is_path_valid(const std::filesystem::path unsafe_path); | ||
|
||
private: | ||
IpDevice() = delete; | ||
IpDevice(const std::filesystem::path valid_path) //! Dont allow unvalidated paths | ||
: PlatformDevice(valid_path){}; | ||
|
||
public: | ||
size_t addr() const; | ||
std::string ip_name() const; | ||
}; | ||
|
||
} // namespace devices | ||
} // namespace kernel | ||
} // namespace villas |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
/* Implementation of driver interface for Linux/Unix based operation system drivers. | ||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#pragma once | ||
|
||
#include <filesystem> | ||
#include <fstream> | ||
#include <iostream> | ||
#include <villas/kernel/devices/driver.hpp> | ||
|
||
namespace villas { | ||
namespace kernel { | ||
namespace devices { | ||
|
||
class LinuxDriver : public Driver { | ||
private: | ||
static constexpr char BIND_DEFAULT[] = "bind"; | ||
static constexpr char UNBIND_DEFAULT[] = "unbind"; | ||
|
||
public: | ||
const std::filesystem::path path; | ||
|
||
private: | ||
const std::filesystem::path bind_path; | ||
const std::filesystem::path unbind_path; | ||
|
||
public: | ||
LinuxDriver(const std::filesystem::path path) | ||
: LinuxDriver(path, path / std::filesystem::path(BIND_DEFAULT), | ||
path / std::filesystem::path(UNBIND_DEFAULT)){}; | ||
|
||
LinuxDriver(const std::filesystem::path path, | ||
const std::filesystem::path bind_path, | ||
const std::filesystem::path unbind_path) | ||
: path(path), bind_path(bind_path), unbind_path(unbind_path){}; | ||
|
||
public: | ||
void attach(const Device &device) const override; | ||
void bind(const Device &device) const override; | ||
std::string name() const override; | ||
void override(const Device &device) const override; | ||
void unbind(const Device &device) const override; | ||
}; | ||
|
||
} // namespace devices | ||
} // namespace kernel | ||
} // namespace villas |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
/* Platform Device: Platform bus based Linux/Unix device. | ||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#pragma once | ||
|
||
#include <filesystem> | ||
#include <villas/kernel/devices/device.hpp> | ||
#include <villas/kernel/devices/driver.hpp> | ||
|
||
namespace villas { | ||
namespace kernel { | ||
namespace devices { | ||
|
||
class PlatformDevice : public Device { | ||
private: | ||
static constexpr char PROBE_DEFAULT[] = "/sys/bus/platform/drivers_probe"; | ||
static constexpr char OVERRIDE_DEFAULT[] = "driver_override"; | ||
|
||
private: | ||
const std::filesystem::path m_path; | ||
const std::filesystem::path m_probe_path; | ||
const std::filesystem::path m_override_path; | ||
|
||
public: | ||
PlatformDevice(const std::filesystem::path path) | ||
: PlatformDevice(path, std::filesystem::path(PROBE_DEFAULT), | ||
path / std::filesystem::path(OVERRIDE_DEFAULT)){}; | ||
|
||
PlatformDevice(const std::filesystem::path path, | ||
const std::filesystem::path probe_path, | ||
const std::filesystem::path override_path) | ||
: m_path(path), m_probe_path(probe_path), | ||
m_override_path(override_path){}; | ||
|
||
// Implement device interface | ||
std::optional<std::unique_ptr<Driver>> driver() const override; | ||
std::optional<int> iommu_group() const override; | ||
std::string name() const override; | ||
std::filesystem::path override_path() const override; | ||
std::filesystem::path path() const override; | ||
void probe() const override; | ||
}; | ||
|
||
} // namespace devices | ||
} // namespace kernel | ||
} // namespace villas |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -11,6 +11,7 @@ | |||||
#include <list> | ||||||
#include <string> | ||||||
#include <vector> | ||||||
#include <filesystem> | ||||||
|
||||||
#include <cassert> | ||||||
#include <cstdint> | ||||||
|
@@ -211,6 +212,9 @@ template <class... Ts> struct overloaded : Ts... { | |||||
// explicit deduction guide (not needed as of C++20) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
template <class... Ts> overloaded(Ts...) -> overloaded<Ts...>; | ||||||
|
||||||
void write_to_file(std::string data, const std::filesystem::path file); | ||||||
std::vector<std::string> read_names_in_directory(const std::filesystem::path &directory); | ||||||
|
||||||
namespace base64 { | ||||||
|
||||||
using byte = std::uint8_t; | ||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/* IpDevice | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please turn this comment into a sentence which briefly describes what this class is doing? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has not been addressed... |
||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#include <filesystem> | ||
#include <regex> | ||
#include <stdexcept> | ||
|
||
#include <villas/exceptions.hpp> | ||
#include <villas/kernel/devices/ip_device.hpp> | ||
|
||
using villas::kernel::devices::IpDevice; | ||
|
||
IpDevice IpDevice::from(const std::filesystem::path unsafe_path) { | ||
if (!is_path_valid(unsafe_path)) | ||
throw RuntimeError( | ||
"Path {} failed validation as IpDevicePath [adress in hex].[name] ", | ||
unsafe_path.u8string()); | ||
return IpDevice(unsafe_path); | ||
} | ||
|
||
std::string IpDevice::ip_name() const { | ||
int pos = name().find('.'); | ||
return name().substr(pos + 1); | ||
IgnoreWarnings marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
size_t IpDevice::addr() const { | ||
size_t pos = name().find('.'); | ||
std::string addr_hex = name().substr(0, pos); | ||
|
||
// Convert from hex-string to number | ||
std::stringstream ss; | ||
ss << std::hex << addr_hex; | ||
size_t addr = 0; | ||
ss >> addr; | ||
|
||
return addr; | ||
} | ||
|
||
bool IpDevice::is_path_valid(const std::filesystem::path unsafe_path) { | ||
std::string assumed_device_name = unsafe_path.filename(); | ||
|
||
// Match format of hexaddr.devicename | ||
if (!std::regex_match(assumed_device_name, | ||
std::regex(R"([0-9A-Fa-f]+\..*)"))) { | ||
return false; | ||
} | ||
|
||
return true; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
/* LinuxDriver | ||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#include <villas/kernel/devices/linux_driver.hpp> | ||
|
||
#include <villas/kernel/devices/device.hpp> | ||
#include <villas/utils.hpp> | ||
|
||
using villas::kernel::devices::Device, villas::kernel::devices::LinuxDriver; | ||
using villas::utils::write_to_file; | ||
|
||
void LinuxDriver::attach(const Device &device) const { | ||
if (device.driver().has_value()) { | ||
device.driver().value()->unbind(device); | ||
} | ||
this->override(device); | ||
device.probe(); | ||
} | ||
|
||
void LinuxDriver::bind(const Device &device) const { | ||
write_to_file(device.name(), this->bind_path); | ||
} | ||
|
||
std::string LinuxDriver::name() const { | ||
size_t pos = path.u8string().rfind('/'); | ||
return path.u8string().substr(pos + 1); | ||
} | ||
|
||
void LinuxDriver::override(const Device &device) const { | ||
write_to_file(this->name(), device.override_path()); | ||
} | ||
|
||
void LinuxDriver::unbind(const Device &device) const { | ||
write_to_file(device.name(), this->unbind_path); | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* Platform Device | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you please turn this comment into a sentence which briefly describes what this class is doing? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has not been addressed... |
||
* | ||
* Author: Pascal Bauer <[email protected]> | ||
* | ||
* SPDX-FileCopyrightText: 2023-2024 Pascal Bauer <[email protected]> | ||
* SPDX-License-Identifier: Apache-2.0 | ||
*/ | ||
|
||
#include <villas/kernel/devices/linux_driver.hpp> | ||
#include <villas/kernel/devices/platform_device.hpp> | ||
#include <villas/utils.hpp> | ||
|
||
using villas::kernel::devices::Driver, villas::kernel::devices::LinuxDriver; | ||
using villas::kernel::devices::PlatformDevice; | ||
using villas::utils::write_to_file; | ||
|
||
std::optional<std::unique_ptr<Driver>> PlatformDevice::driver() const { | ||
std::filesystem::path driver_symlink = | ||
this->m_path / std::filesystem::path("driver"); | ||
|
||
if (!std::filesystem::is_symlink(driver_symlink)) | ||
return std::nullopt; | ||
|
||
std::filesystem::path driver_path = | ||
std::filesystem::canonical(driver_symlink); | ||
return std::make_optional(std::make_unique<LinuxDriver>(driver_path)); | ||
} | ||
|
||
std::optional<int> PlatformDevice::iommu_group() const { | ||
std::filesystem::path symlink = | ||
std::filesystem::path(this->m_path.u8string() + "/iommu_group"); | ||
|
||
std::filesystem::path link = std::filesystem::read_symlink(symlink); | ||
std::string delimiter = "iommu_groups/"; | ||
int pos = link.u8string().find(delimiter); | ||
int iommu_group = std::stoi(link.u8string().substr(pos + delimiter.length())); | ||
return std::make_optional<int>(iommu_group); | ||
} | ||
|
||
std::filesystem::path PlatformDevice::path() const { return this->m_path; }; | ||
|
||
void PlatformDevice::probe() const { | ||
write_to_file(this->name(), this->m_probe_path); | ||
} | ||
|
||
std::filesystem::path PlatformDevice::override_path() const { | ||
return this->m_override_path; | ||
} | ||
|
||
std::string PlatformDevice::name() const { return this->m_path.filename(); } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just wondering: has this work been done as part of a contract with RWTH? Shouldnt we add RWTH as the copyright holder in this case?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I felt like the result of our discussion on this topic was that we do not enforce whether we list a company or a person here. I'm still of the opinion that the university cannot be the copyright owner.