AdsLib.cpp

// SPDX-License-Identifier: MIT
/**
   Copyright (c) 2015 - 2022 Beckhoff Automation GmbH & Co. KG
 */

#include "AdsLib.h"
#include "AmsRouter.h"

static AmsRouter &GetRouter()
{
	static AmsRouter router;
	return router;
}

#define ASSERT_PORT(port)                                 \
	do {                                              \
		if ((port) <= 0 || (port) > UINT16_MAX) { \
			return ADSERR_CLIENT_PORTNOTOPEN; \
		}                                         \
	} while (false)

#define ASSERT_PORT_AND_AMSADDR(port, pAddr)            \
	do {                                            \
		ASSERT_PORT(port);                      \
		if (!(pAddr)) {                         \
			return ADSERR_CLIENT_NOAMSADDR; \
		}                                       \
	} while (false)

namespace bhf
{
namespace ads
{
long AddLocalRoute(const AmsNetId ams, const char *ip)
{
	try {
		return GetRouter().AddRoute(ams, ip);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	} catch (const std::runtime_error &) {
		return GLOBALERR_TARGET_PORT;
	}
}

void DelLocalRoute(const AmsNetId ams)
{
	GetRouter().DelRoute(ams);
}

void SetLocalAddress(const AmsNetId ams)
{
	GetRouter().SetLocalAddress(ams);
}
}
}

long AdsPortCloseEx(long port)
{
	ASSERT_PORT(port);
	return GetRouter().ClosePort((uint16_t)port);
}

long AdsPortOpenEx()
{
	return GetRouter().OpenPort();
}

long AdsGetLocalAddressEx(long port, AmsAddr *pAddr)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	return GetRouter().GetLocalAddress((uint16_t)port, pAddr);
}

long AdsSyncReadReqEx2(long port, const AmsAddr *pAddr, uint32_t indexGroup,
		       uint32_t indexOffset, uint32_t bufferLength,
		       void *buffer, uint32_t *bytesRead)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if (!buffer) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		AmsRequest request{ *pAddr,
				    (uint16_t)port,
				    AoEHeader::READ,
				    bufferLength,
				    buffer,
				    bytesRead,
				    sizeof(AoERequestHeader) };
		request.frame.prepend(AoERequestHeader{ indexGroup, indexOffset,
							bufferLength });
		return GetRouter().AdsRequest(request);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncReadDeviceInfoReqEx(long port, const AmsAddr *pAddr, char *devName,
				AdsVersion *version)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if (!devName || !version) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		static const size_t NAME_LENGTH = 16;
		uint8_t buffer[sizeof(*version) + NAME_LENGTH];
		AmsRequest request{ *pAddr, (uint16_t)port,
				    AoEHeader::READ_DEVICE_INFO, sizeof(buffer),
				    buffer };
		const auto status = GetRouter().AdsRequest(request);
		if (!status) {
			version->version = buffer[0];
			version->revision = buffer[1];
			version->build = bhf::ads::letoh<uint16_t>(
				buffer + offsetof(AdsVersion, build));
			memcpy(devName, buffer + sizeof(*version), NAME_LENGTH);
		}
		return status;
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncReadStateReqEx(long port, const AmsAddr *pAddr, uint16_t *adsState,
			   uint16_t *devState)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if (!adsState || !devState) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		uint16_t buffer[2];
		AmsRequest request{ *pAddr, (uint16_t)port,
				    AoEHeader::READ_STATE, sizeof(buffer),
				    buffer };
		const auto status = GetRouter().AdsRequest(request);
		if (!status) {
			*adsState = bhf::ads::letoh(buffer[0]);
			*devState = bhf::ads::letoh(buffer[1]);
		}
		return status;
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncReadWriteReqEx2(long port, const AmsAddr *pAddr,
			    uint32_t indexGroup, uint32_t indexOffset,
			    uint32_t readLength, void *readData,
			    uint32_t writeLength, const void *writeData,
			    uint32_t *bytesRead)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if ((readLength && !readData) || (writeLength && !writeData)) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		AmsRequest request{ *pAddr,
				    (uint16_t)port,
				    AoEHeader::READ_WRITE,
				    readLength,
				    readData,
				    bytesRead,
				    sizeof(AoEReadWriteReqHeader) +
					    writeLength };
		request.frame.prepend(writeData, writeLength);
		request.frame.prepend(AoEReadWriteReqHeader{
			indexGroup, indexOffset, readLength, writeLength });
		return GetRouter().AdsRequest(request);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncWriteReqEx(long port, const AmsAddr *pAddr, uint32_t indexGroup,
		       uint32_t indexOffset, uint32_t bufferLength,
		       const void *buffer)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if (bufferLength && !buffer) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		AmsRequest request{
			*pAddr,
			(uint16_t)port,
			AoEHeader::WRITE,
			0,
			nullptr,
			nullptr,
			sizeof(AoERequestHeader) + bufferLength,
		};
		request.frame.prepend(buffer, bufferLength);
		request.frame.prepend<AoERequestHeader>(
			{ indexGroup, indexOffset, bufferLength });
		return GetRouter().AdsRequest(request);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncWriteControlReqEx(long port, const AmsAddr *pAddr,
			      uint16_t adsState, uint16_t devState,
			      uint32_t bufferLength, const void *buffer)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	try {
		AmsRequest request{ *pAddr,
				    (uint16_t)port,
				    AoEHeader::WRITE_CONTROL,
				    0,
				    nullptr,
				    nullptr,
				    sizeof(AdsWriteCtrlRequest) +
					    bufferLength };
		request.frame.prepend(buffer, bufferLength);
		request.frame.prepend<AdsWriteCtrlRequest>(
			{ adsState, devState, bufferLength });
		return GetRouter().AdsRequest(request);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncAddDeviceNotificationReqEx(long port, const AmsAddr *pAddr,
				       uint32_t indexGroup,
				       uint32_t indexOffset,
				       const AdsNotificationAttrib *pAttrib,
				       PAdsNotificationFuncEx pFunc,
				       uint32_t hUser, uint32_t *pNotification)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if (!pAttrib || !pFunc || !pNotification) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		uint8_t buffer[sizeof(*pNotification)];
		AmsRequest request{ *pAddr,
				    (uint16_t)port,
				    AoEHeader::ADD_DEVICE_NOTIFICATION,
				    sizeof(buffer),
				    buffer,
				    nullptr,
				    sizeof(AdsAddDeviceNotificationRequest) };
		request.frame.prepend(AdsAddDeviceNotificationRequest{
			indexGroup, indexOffset, pAttrib->cbLength,
			pAttrib->nTransMode, pAttrib->nMaxDelay,
			pAttrib->nCycleTime });
		auto notify = std::make_shared<Notification>(pFunc, hUser,
							     pAttrib->cbLength,
							     *pAddr,
							     (uint16_t)port);
		return GetRouter().AddNotification(request, pNotification,
						   notify);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsSyncDelDeviceNotificationReqEx(long port, const AmsAddr *pAddr,
				       uint32_t hNotification)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	return GetRouter().DelNotification((uint16_t)port, pAddr,
					   hNotification);
}

long AdsAddSyntheticDeviceNotificationReqEx(long port, const AmsAddr *pAddr,
				       uint32_t nType,
				       PAdsSyntheticNotificationFuncEx pFunc,
				       uint32_t hUser, uint32_t *pNotification)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	if (!pFunc || !pNotification) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	if (nType != NOTIFY_NOTIFICATION_RCV &&
	    nType != NOTIFY_CONNECTION_LOST) {
		return ADSERR_CLIENT_INVALIDPARM;
	}

	try {
		auto notify = std::make_shared<SyntheticNotification>(
			pFunc, hUser, *pAddr, (uint16_t)port, nType);
		return GetRouter().AddSyntheticNotification(
			(uint16_t)port, *pAddr, pNotification, notify);
	} catch (const std::bad_alloc &) {
		return GLOBALERR_NO_MEMORY;
	}
}

long AdsDelSyntheticDeviceNotificationReqEx(long port, const AmsAddr *pAddr,
				       uint32_t hNotification)
{
	ASSERT_PORT_AND_AMSADDR(port, pAddr);
	return GetRouter().DelSyntheticNotification((uint16_t)port, pAddr,
						    hNotification);
}

long AdsSyncGetTimeoutEx(long port, uint32_t *timeout)
{
	ASSERT_PORT(port);
	if (!timeout) {
		return ADSERR_CLIENT_INVALIDPARM;
	}
	return GetRouter().GetTimeout((uint16_t)port, *timeout);
}

long AdsSyncSetTimeoutEx(long port, uint32_t timeout)
{
	ASSERT_PORT(port);
	return GetRouter().SetTimeout((uint16_t)port, timeout);
}