HardwareSPI_FTDI.h

#pragma once
/*
  HardwareSPI_FTDI.h 
  Copyright (c) 2025 Phil Schatzmann. All right reserved.
 
  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.
 
  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.
 
  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifdef USE_FTDI
#include <inttypes.h>
#include <ftdi.h>
// Undefine DEPRECATED macro from libftdi1 to avoid conflict with Arduino API
#ifdef DEPRECATED
#undef DEPRECATED
#endif
 
#include "api/Common.h"
#include "api/HardwareSPI.h"
#include "api/Stream.h"
 
namespace arduino {
 
class HardwareSPI_FTDI : public HardwareSPI {
 public:
  HardwareSPI_FTDI(int channel = 0);
 
  ~HardwareSPI_FTDI() override;
 
  void begin() override {
    begin(0x0403, 0x6010);
  }
 
  bool begin(int vendor_id, int product_id, 
            const char* description = nullptr, const char* serial = nullptr);
 
  void end() override;
 
  uint8_t transfer(uint8_t data) override;
 
  uint16_t transfer16(uint16_t data) override;
 
  void transfer(void* buf, size_t count) override;
 
  // Transaction Functions
  void usingInterrupt(int interruptNumber) override;
 
  void notUsingInterrupt(int interruptNumber) override;
 
  void beginTransaction(SPISettings settings) override;
 
  void endTransaction(void) override;
 
  // SPI Configuration methods
  void attachInterrupt() override;
 
  void detachInterrupt() override;
 
  operator bool() { return is_open && ftdi_context != nullptr; }
 
 protected:
  struct ftdi_context* ftdi_context = nullptr;
  int ftdi_channel = 0;  // 0 for Channel A, 1 for Channel B
  bool is_open = false;
  
  // Current SPI settings
  uint32_t current_clock = 1000000;     // Default 1MHz
  SPIMode current_mode = SPI_MODE0;     // Default mode 0
  BitOrder current_bit_order = MSBFIRST; // Default MSB first
  
    // MPSSE command definitions for SPI (using different names to avoid macro conflicts)
  static const uint8_t CMD_WRITE_NEG = 0x01;     // Write TDI/DO on negative clock edge
  static const uint8_t CMD_BITMODE = 0x02;       // Write in bit mode
  static const uint8_t CMD_READ_NEG = 0x04;      // Read TDO/DI on negative clock edge
  static const uint8_t CMD_LSB = 0x08;           // LSB first
  static const uint8_t CMD_DO_WRITE = 0x10;      // Write TDI/DO
  static const uint8_t CMD_DO_READ = 0x20;       // Read TDO/DI
  static const uint8_t CMD_WRITE_TMS = 0x40;     // Write TMS/CS
 
  bool configureMPSSE();
 
  bool setClockFrequency(uint32_t frequency);
 
  uint8_t getMPSSECommand(bool read_enable, bool write_enable);
 
  int sendData(const uint8_t* data, size_t length);
 
  int receiveData(uint8_t* data, size_t length);
};
 
}  // namespace arduino
 
#endif  // USE_FTDI