Skip to content

Device io control wrapper #254

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.

Sign up for GitHub

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

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from
Draft

Device io control wrapper #254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
dd45eb9
initial template
forwardpointer Apr 21, 2023
d1e42af
Merge branch 'develop' into DeviceIOControlWrapper
forwardpointer Apr 21, 2023
73efa4a
Merge branch 'develop' into DeviceIOControlWrapper
forwardpointer Apr 24, 2023
ccdc1a0
format
forwardpointer Apr 25, 2023
ebea86a
Merge branch 'develop' into DeviceIOControlWrapper
forwardpointer Apr 25, 2023
dd8c306
first use of device io control wrapper
forwardpointer Apr 25, 2023
e75c141
Merge branch 'develop' into DeviceIOControlWrapper
forwardpointer Apr 28, 2023
21f62ad
change the interface to be more concise
forwardpointer Apr 28, 2023
c101297
reset
forwardpointer Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 63 additions & 47 deletions windows/devices/uwb/UwbConnector.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,41 +136,60 @@ UwbConnector::DeviceName() const noexcept
return m_deviceName;
}

std::future<void>
UwbConnector::Reset()
template <typename PromiseT, typename... ArgTs>
void
UwbConnector::DeviceIoControlWrapper(std::promise<PromiseT>& resultPromise, std::string strFail, std::string strSuccess, std::function<void()> interpret, ArgTs&&... args)
{
std::promise<void> resultPromise{};
auto resultFuture = resultPromise.get_future();

wil::unique_hfile handleDriver;
auto hr = OpenDriverHandle(handleDriver, m_deviceName.c_str());
if (FAILED(hr)) {
PLOG_ERROR << "failed to obtain driver handle for " << m_deviceName << ", hr=" << std::showbase << std::hex << hr;
resultPromise.set_exception(std::make_exception_ptr(UwbException(UwbStatusGeneric::Rejected)));
return resultFuture;
return;
}

BOOL ioResult = DeviceIoControl(handleDriver.get(), std::forward<ArgTs>(args)...);
if (!LOG_IF_WIN32_BOOL_FALSE(ioResult)) {
HRESULT hr = HRESULT_FROM_WIN32(GetLastError());
PLOG_ERROR << strFail << ", hr = " << std::showbase << std::hex << hr;
resultPromise.set_exception(std::make_exception_ptr(UwbException(UwbStatusGeneric::Rejected)));
} else {
PLOG_DEBUG << strSuccess;
interpret();
}
}

std::future<void>
UwbConnector::Reset()
{
std::promise<void> resultPromise{};
auto resultFuture = resultPromise.get_future();

const UWB_DEVICE_RESET deviceReset{
.size = sizeof(UWB_DEVICE_RESET),
.resetConfig = UWB_RESET_CONFIG_UWBS_RESET,
};
UWB_STATUS status;

BOOL ioResult = DeviceIoControl(handleDriver.get(), IOCTL_UWB_DEVICE_RESET, const_cast<UWB_DEVICE_RESET*>(&deviceReset), sizeof deviceReset, &status, sizeof status, nullptr, nullptr);
if (!LOG_IF_WIN32_BOOL_FALSE(ioResult)) {
HRESULT hr = HRESULT_FROM_WIN32(GetLastError());
PLOG_ERROR << "error when sending IOCTL_UWB_DEVICE_RESET, hr=" << std::showbase << std::hex << hr;
resultPromise.set_exception(std::make_exception_ptr(UwbException(UwbStatusGeneric::Failed)));
return resultFuture;
} else {
PLOG_DEBUG << "IOCTL_UWB_DEVICE_RESET succeeded";
auto uwbStatus = UwbCxDdi::To(status);
if (!IsUwbStatusOk(uwbStatus)) {
resultPromise.set_exception(std::make_exception_ptr(UwbException(std::move(uwbStatus))));
} else {
resultPromise.set_value();
}
}
DeviceIoControlWrapper(
resultPromise,
"error when sending IOCTL_UWB_DEVICE_RESET",
"IOCTL_UWB_DEVICE_RESET succeeded",
[&]() {
auto uwbStatus = UwbCxDdi::To(status);
if (!IsUwbStatusOk(uwbStatus)) {
resultPromise.set_exception(std::make_exception_ptr(UwbException(std::move(uwbStatus))));
} else {
resultPromise.set_value();
}
},
IOCTL_UWB_DEVICE_RESET,
const_cast<UWB_DEVICE_RESET*>(&deviceReset),
sizeof deviceReset,
&status,
sizeof status,
nullptr,
nullptr);

return resultFuture;
}
Expand Down Expand Up @@ -637,14 +656,6 @@ UwbConnector::SetApplicationConfigurationParameters(uint32_t sessionId, std::vec
std::promise<std::tuple<UwbStatus, std::vector<UwbSetApplicationConfigurationParameterStatus>>> resultPromise;
auto resultFuture = resultPromise.get_future();

wil::shared_hfile handleDriver;
auto hr = OpenDriverHandle(handleDriver, m_deviceName.c_str());
if (FAILED(hr)) {
PLOG_ERROR << "failed to obtain driver handle for " << m_deviceName << ", hr=" << std::showbase << std::hex << hr;
resultPromise.set_exception(std::make_exception_ptr(UwbException(UwbStatusGeneric::Rejected)));
return resultFuture;
}

UwbCxDdi::UwbSetApplicationConfigurationParameters uwbSetApplicationConfigurationParameters{
.SessionId = sessionId,
.Parameters = std::move(applicationConfigurationParameters),
Expand All @@ -655,24 +666,29 @@ UwbConnector::SetApplicationConfigurationParameters(uint32_t sessionId, std::vec

auto statusSize = offsetof(UWB_SET_APP_CONFIG_PARAMS_STATUS, appConfigParamsStatus[std::size(uwbSetApplicationConfigurationParameters.Parameters)]);
std::vector<uint8_t> statusBuffer(statusSize);
BOOL ioResult = DeviceIoControl(handleDriver.get(), IOCTL_UWB_SET_APP_CONFIG_PARAMS, std::data(paramsBuffer), std::size(paramsBuffer), std::data(statusBuffer), statusSize, nullptr, nullptr);
if (!LOG_IF_WIN32_BOOL_FALSE(ioResult)) {
HRESULT hr = HRESULT_FROM_WIN32(GetLastError());
PLOG_ERROR << "error when sending IOCTL_UWB_SET_APP_CONFIG_PARAMS with sessionId " << sessionId << ", hr = " << std::showbase << std::hex << hr;
resultPromise.set_exception(std::make_exception_ptr(UwbException(UwbStatusGeneric::Rejected)));
return resultFuture;
} else {
PLOG_DEBUG << "IOCTL_UWB_SET_APP_CONFIG_PARAMS succeeded";
auto& setApplicationConfigurationParametersStatus = *reinterpret_cast<UWB_SET_APP_CONFIG_PARAMS_STATUS*>(std::data(statusBuffer));
auto uwbStatus = UwbCxDdi::To(setApplicationConfigurationParametersStatus.status);
if (!IsUwbStatusOk(uwbStatus)) {
resultPromise.set_exception(std::make_exception_ptr(UwbException(std::move(uwbStatus))));
} else {
auto uwbSetApplicationConfigurationParametersStatus = UwbCxDdi::To(setApplicationConfigurationParametersStatus);
auto result = std::make_tuple(uwbSetApplicationConfigurationParametersStatus.Status, std::move(uwbSetApplicationConfigurationParametersStatus.ParameterStatuses));
resultPromise.set_value(std::move(result));
}
}

DeviceIoControlWrapper(
resultPromise,
"error when sending IOCTL_UWB_SET_APP_CONFIG_PARAMS with sessionId " + std::to_string(sessionId),
"IOCTL_UWB_SET_APP_CONFIG_PARAMS succeeded",
[&]() {
auto& setApplicationConfigurationParametersStatus = *reinterpret_cast<UWB_SET_APP_CONFIG_PARAMS_STATUS*>(std::data(statusBuffer));
auto uwbStatus = UwbCxDdi::To(setApplicationConfigurationParametersStatus.status);
if (!IsUwbStatusOk(uwbStatus)) {
resultPromise.set_exception(std::make_exception_ptr(UwbException(std::move(uwbStatus))));
} else {
auto uwbSetApplicationConfigurationParametersStatus = UwbCxDdi::To(setApplicationConfigurationParametersStatus);
auto result = std::make_tuple(uwbSetApplicationConfigurationParametersStatus.Status, std::move(uwbSetApplicationConfigurationParametersStatus.ParameterStatuses));
resultPromise.set_value(std::move(result));
}
},
IOCTL_UWB_SET_APP_CONFIG_PARAMS,
std::data(paramsBuffer),
std::size(paramsBuffer),
std::data(statusBuffer),
statusSize,
nullptr,
nullptr);

return resultFuture;
}
Expand Down
16 changes: 16 additions & 0 deletions windows/devices/uwb/include/windows/devices/uwb/UwbConnector.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,22 @@ private:
bool
CallbacksPresent();

// Internal function that wraps DeviceIoControl, handles errors and insufficient buffer size
/**
* @brief
*
* @tparam PromiseT
* @tparam ArgTs is everything that goes into a standard DeviceIOControl() call, aside from the leading handle argument
* @param resultPromise
* @param strFail
* @param strSuccess
* @param interpret
* @param args
*/
template <typename PromiseT, typename... ArgTs>
void
DeviceIoControlWrapper(std::promise<PromiseT>& resultPromise, std::string strFail, std::string strSuccess, std::function<void()> interpret, ArgTs&&... args);

private:
std::string m_deviceName{};
std::jthread m_notificationThread;
Expand Down