GPIO hardware abstraction for FTDI FT2232HL in the Arduino emulator. More...

#include <HardwareGPIO_FTDI.h>

Inheritance diagram for arduino::HardwareGPIO_FTDI:

Classes
struct	PWMPin

Public Member Functions
	HardwareGPIO_FTDI ()=default
	Constructor for HardwareGPIO_FTDI.

	~HardwareGPIO_FTDI ()
	Destructor for HardwareGPIO_FTDI.

int	analogRead (pin_size_t pinNumber) override
	Read an analog value from a pin (not supported by FT2232HL).

void	analogReference (uint8_t mode) override
	Set the analog reference mode (not supported by FT2232HL).

void	analogWrite (pin_size_t pinNumber, int value) override
	Write an analog value (PWM) to a pin using software PWM.

void	analogWriteFrequency (pin_size_t pinNumber, uint32_t frequency)
	Set the PWM frequency for analogWrite() on a specific pin.

void	analogWriteResolution (uint8_t bits) override
	Set the resolution for analogWrite() operations.

bool	begin (int vendor_id=0x0403, int product_id=0x6010, const char description=nullptr, const char serial=nullptr)
	Initialize the GPIO hardware interface for FTDI FT2232HL.

PinStatus	digitalRead (pin_size_t pinNumber) override
	Read a digital value from a GPIO pin.

void	digitalWrite (pin_size_t pinNumber, PinStatus status) override
	Write a digital value to a GPIO pin.

void	end ()
	Close the FTDI connection and cleanup resources.

void	getPWMStatistics (pin_size_t pin, uint64_t &cycles, uint64_t &max_jitter_us, uint64_t &avg_jitter_us)
	Get PWM statistics for monitoring timing accuracy.

void	noTone (uint8_t _pin) override
	Stop tone generation on a pin (not supported by FT2232HL).

	operator bool ()
	Boolean conversion operator.

void	pinMode (pin_size_t pinNumber, PinMode pinMode) override
	Set the mode of a GPIO pin (INPUT, OUTPUT, etc).

unsigned long	pulseIn (uint8_t pin, uint8_t state, unsigned long timeout=1000000L) override
	Measure pulse duration on a pin (not supported by FT2232HL).

unsigned long	pulseInLong (uint8_t pin, uint8_t state, unsigned long timeout=1000000L) override
	Measure long pulse duration on a pin (not supported by FT2232HL).

void	tone (uint8_t _pin, unsigned int frequency, unsigned long duration=0) override
	Generate a tone on a pin (not supported by FT2232HL).

Protected Member Functions
int	getBitPosition (pin_size_t pin)
	Get the bit position within a channel for a given pin.

int	getChannel (pin_size_t pin)
	Get the channel number for a given pin.

void	pwmThreadFunction ()
	PWM thread function that handles software PWM generation.

bool	readGPIOState (int channel, uint8_t &value)
	Read current GPIO state from the FTDI device.

void	startPWMThread ()
	Start the PWM background thread.

void	stopPWMThread ()
	Stop the PWM background thread.

bool	updateGPIOState (int channel)
	Update the GPIO state on the FTDI device.

void	updatePWMPin (pin_size_t pin, uint8_t duty_cycle, uint32_t frequency=1000)
	Update PWM pin configuration.

Protected Attributes
struct ftdi_context *	ftdi_context = nullptr

bool	is_open = false

uint8_t	pin_directions_a = 0x00

uint8_t	pin_directions_b = 0x00

std::map< pin_size_t, PinMode >	pin_modes

uint8_t	pin_values_a = 0x00

uint8_t	pin_values_b = 0x00

std::mutex	pwm_mutex

std::map< pin_size_t, PWMPin >	pwm_pins

std::thread	pwm_thread

std::atomic< bool >	pwm_thread_running {false}

Detailed Description

GPIO hardware abstraction for FTDI FT2232HL in the Arduino emulator.

This class implements the Arduino-style GPIO interface for FTDI FT2232HL devices, allowing digital I/O operations to be used in a manner compatible with Arduino code. The FT2232HL provides 16 GPIO pins (8 per channel) that can be configured for digital input/output.

Pin mapping for FT2232HL:

Channel A (ADBUS): Pins 0-7 (ADBUS0-ADBUS7)
Channel B (BDBUS): Pins 8-15 (BDBUS0-BDBUS7)

The class inherits from HardwareGPIO and is intended for use within the emulator when communicating with FTDI FT2232HL devices. It manages pin state and direction for supported pins.

Note: This class is only available when USE_FTDI is defined.; Requires libftdi1 development library to be installed.

Member Function Documentation

◆ analogRead()

int arduino::HardwareGPIO_FTDI::analogRead ( pin_size_t pinNumber )

overridevirtual

Read an analog value from a pin (not supported by FT2232HL).

Parameters

pinNumber Pin number

Returns: Always returns 0 (no ADC on FT2232HL)

Implements arduino::HardwareGPIO.

◆ analogReference()

void arduino::HardwareGPIO_FTDI::analogReference ( uint8_t mode )

overridevirtual

Set the analog reference mode (not supported by FT2232HL).

Parameters

mode	Reference mode (ignored)

Implements arduino::HardwareGPIO.

◆ analogWrite()

void arduino::HardwareGPIO_FTDI::analogWrite	(	pin_size_t	pinNumber,
		int	value
	)

overridevirtual

Write an analog value (PWM) to a pin using software PWM.

Parameters

pinNumber	Pin number (0-15)
value	PWM duty cycle (0-255, where 0=0% and 255=100%)

Implements arduino::HardwareGPIO.

◆ analogWriteFrequency()

void arduino::HardwareGPIO_FTDI::analogWriteFrequency	(	pin_size_t	pinNumber,
		uint32_t	frequency
	)

virtual

Set the PWM frequency for analogWrite() on a specific pin.

Parameters

pinNumber	Pin number (0-15)
frequency	PWM frequency in Hz (default: 1000Hz)

Implements arduino::HardwareGPIO.

◆ analogWriteResolution()

void arduino::HardwareGPIO_FTDI::analogWriteResolution ( uint8_t bits )

overridevirtual

Set the resolution for analogWrite() operations.

Parameters

bits	The resolution in bits (8-bit by default for FTDI)

Note: FT2232HL supports 8-bit PWM resolution (0-255)

Implements arduino::HardwareGPIO.

◆ begin()

bool arduino::HardwareGPIO_FTDI::begin	(	int	vendor_id = `0x0403`,
		int	product_id = `0x6010`,
		const char *	description = `nullptr`,
		const char *	serial = `nullptr`
	)

Initialize the GPIO hardware interface for FTDI FT2232HL.

Parameters

vendor_id	USB vendor ID (default: 0x0403)
product_id	USB product ID (default: 0x6010 for FT2232HL)
description	Device description string (optional)
serial	Device serial number (optional)

Returns: true if initialization successful, false otherwise

◆ digitalRead()

PinStatus arduino::HardwareGPIO_FTDI::digitalRead ( pin_size_t pinNumber )

overridevirtual

Read a digital value from a GPIO pin.

Parameters

pinNumber Pin number (0-15)

Returns: Pin status (HIGH or LOW)

Implements arduino::HardwareGPIO.

◆ digitalWrite()

void arduino::HardwareGPIO_FTDI::digitalWrite	(	pin_size_t	pinNumber,
		PinStatus	status
	)

overridevirtual

Write a digital value to a GPIO pin.

Parameters

pinNumber	Pin number (0-15)
status	Pin status (HIGH or LOW)

Implements arduino::HardwareGPIO.

◆ getBitPosition()

int arduino::HardwareGPIO_FTDI::getBitPosition ( pin_size_t pin )

inlineprotected

Get the bit position within a channel for a given pin.

Parameters

pin	Pin number (0-15)

Returns: Bit position (0-7)

◆ getChannel()

int arduino::HardwareGPIO_FTDI::getChannel ( pin_size_t pin )

inlineprotected

Get the channel number for a given pin.

Parameters

pin	Pin number (0-15)

Returns: Channel number (0 for pins 0-7, 1 for pins 8-15)

◆ getPWMStatistics()

void arduino::HardwareGPIO_FTDI::getPWMStatistics	(	pin_size_t	pin,
		uint64_t &	cycles,
		uint64_t &	max_jitter_us,
		uint64_t &	avg_jitter_us
	)

Get PWM statistics for monitoring timing accuracy.

Parameters

pin	Pin number
cycles	Total number of PWM cycles completed
max_jitter_us	Maximum jitter observed in microseconds
avg_jitter_us	Average jitter in microseconds

◆ noTone()

void arduino::HardwareGPIO_FTDI::noTone ( uint8_t _pin )

overridevirtual

Stop tone generation on a pin (not supported by FT2232HL).

Parameters

_pin	Pin number (ignored)

Implements arduino::HardwareGPIO.

◆ operator bool()

arduino::HardwareGPIO_FTDI::operator bool ( )

inline

Boolean conversion operator.

Returns: true if the FTDI interface is open and initialized, false otherwise.

◆ pinMode()

void arduino::HardwareGPIO_FTDI::pinMode	(	pin_size_t	pinNumber,
		PinMode	pinMode
	)

overridevirtual

Set the mode of a GPIO pin (INPUT, OUTPUT, etc).

Parameters

pinNumber	Pin number (0-15 for FT2232HL)
pinMode	Pin mode (INPUT, OUTPUT, INPUT_PULLUP)

Implements arduino::HardwareGPIO.

◆ pulseIn()

unsigned long arduino::HardwareGPIO_FTDI::pulseIn	(	uint8_t	pin,
		uint8_t	state,
		unsigned long	timeout = `1000000L`
	)

overridevirtual

Measure pulse duration on a pin (not supported by FT2232HL).

Parameters

pin	Pin number
state	Pin state to measure
timeout	Timeout in microseconds

Returns: Always returns 0 (not implemented)

Implements arduino::HardwareGPIO.

◆ pulseInLong()

unsigned long arduino::HardwareGPIO_FTDI::pulseInLong	(	uint8_t	pin,
		uint8_t	state,
		unsigned long	timeout = `1000000L`
	)

overridevirtual

Measure long pulse duration on a pin (not supported by FT2232HL).

Parameters

pin	Pin number
state	Pin state to measure
timeout	Timeout in microseconds

Returns: Always returns 0 (not implemented)

Implements arduino::HardwareGPIO.

◆ readGPIOState()

bool arduino::HardwareGPIO_FTDI::readGPIOState	(	int	channel,
		uint8_t &	value
	)

protected

Read current GPIO state from the FTDI device.

Parameters

channel	Channel to read (0 for A, 1 for B)
value	Reference to store the read value

Returns: true if successful, false on error

◆ tone()

void arduino::HardwareGPIO_FTDI::tone	(	uint8_t	_pin,
		unsigned int	frequency,
		unsigned long	duration = `0`
	)

overridevirtual

Generate a tone on a pin (not supported by FT2232HL).

Parameters

_pin	Pin number
frequency	Frequency in Hz (ignored)
duration	Duration in ms (ignored)

Implements arduino::HardwareGPIO.

◆ updateGPIOState()

bool arduino::HardwareGPIO_FTDI::updateGPIOState ( int channel )

protected

Update the GPIO state on the FTDI device.

Parameters

channel Channel to update (0 for A, 1 for B)

Returns: true if successful, false on error

◆ updatePWMPin()

void arduino::HardwareGPIO_FTDI::updatePWMPin	(	pin_size_t	pin,
		uint8_t	duty_cycle,
		uint32_t	frequency = `1000`
	)

protected

Update PWM pin configuration.

Parameters

pin	Pin number
duty_cycle	Duty cycle (0-255)
frequency	Frequency in Hz

The documentation for this class was generated from the following files:

ArduinoCore-Linux/cores/ftdi/HardwareGPIO_FTDI.h
ArduinoCore-Linux/cores/ftdi/HardwareGPIO_FTDI.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ analogRead()

◆ analogReference()

◆ analogWrite()

◆ analogWriteFrequency()

◆ analogWriteResolution()

◆ begin()

◆ digitalRead()

◆ digitalWrite()

◆ getBitPosition()

◆ getChannel()

◆ getPWMStatistics()

◆ noTone()

◆ operator bool()

◆ pinMode()

◆ pulseIn()

◆ pulseInLong()

◆ readGPIOState()

◆ tone()

◆ updateGPIOState()

◆ updatePWMPin()