/*
 * PinDescription.h
 *
 *  Created on: 10 Jul 2020
 *      Author: David
 */

#ifndef SRC_HARDWARE_SAME70_PINDESCRIPTION_H_
#define SRC_HARDWARE_SAME70_PINDESCRIPTION_H_

#include <CoreIO.h>

// Enum to represent allowed types of pin access
// We don't have a separate bit for servo, because Duet PWM-capable ports can be used for servos if they are on the Duet main board
enum class PinCapability: uint8_t
{
	// Individual capabilities
	none = 0u,
	read = 1u,
	ain = 2u,
	write = 4u,
	pwm = 8u,

	// Combinations
	ainr = 1u|2u,
	rw = 1u|4u,
	wpwm = 4u|8u,
	rwpwm = 1u|4u|8u,
	ainrw = 1u|2u|4u,
	ainrwpwm = 1u|2u|4u|8u
};

constexpr inline PinCapability operator|(PinCapability a, PinCapability b) noexcept
{
	return (PinCapability)((uint8_t)a | (uint8_t)b);
}

// The pin description says what functions are available on each pin, filtered to avoid allocating the same function to more than one pin..
// It is a struct not a class so that it can be direct initialised in read-only memory.
struct PinDescription : public PinDescriptionBase
{
	PinCapability cap;
	const char *_ecv_array null pinNames;

	PinCapability GetCapability() const noexcept { return cap; }
	const char *_ecv_array null GetNames() const noexcept { return pinNames; }
};

#endif /* SRC_HARDWARE_SAME70_PINDESCRIPTION_H_ */