1 // SPDX-License-Identifier: Apache-2.0
2 /*
3  * Copyright (C) 2020 Gwenhael Goavec-Merou <gwenhael.goavec-merou@trabucayre.com>
4  */
5 
6 #ifndef USBBLASTER_H
7 #define USBBLASTER_H
8 #include <ftdi.h>
9 #include <iostream>
10 #include <string>
11 #include <vector>
12 
13 #include "board.hpp"
14 #include "jtagInterface.hpp"
15 #include "ftdipp_mpsse.hpp"
16 #include "fx2_ll.hpp"
17 
18 /*!
19  * \file UsbBlaster.hpp
20  * \class UsbBlaster_ll
21  * \brief altera/intel usb blaster abstract class for blasterI and blasterII
22  * \author Gwenhael Goavec-Merou
23  */
24 
25 class UsbBlaster_ll {
26 	public:
~UsbBlaster_ll()27 		virtual ~UsbBlaster_ll() {}
28 		virtual int setClkFreq(uint32_t clkHZ) = 0;
29 		virtual uint32_t getClkFreq() = 0;
30 		virtual int write(uint8_t *wr_buf, int wr_len,
31 			uint8_t *rd_buf, int rd_len) = 0;
32 };
33 
34 /*!
35  * \file UsbBlaster.hpp
36  * \class UsbBlaster
37  * \brief altera/intel usb blaster implementation
38  * \author Gwenhael Goavec-Merou
39  */
40 
41 class UsbBlaster : public JtagInterface {
42  public:
43 	UsbBlaster(int vid, int pid, const std::string &firmware_path,
44 			uint8_t verbose = 0);
45 	virtual ~UsbBlaster();
46 
47 	int setClkFreq(uint32_t clkHZ) override;
48 	uint32_t getClkFreq() override;
49 
50 	/*!
51 	 * \brief drive TMS to move in JTAG state machine
52 	 * \param tms serie of TMS state
53 	 * \param len number of TMS state
54 	 * \param flush_buffer force flushing the buffer
55 	 * \return number of state written
56 	 * */
57 	int writeTMS(uint8_t *tms, uint32_t len, bool flush_buffer) override;
58 
59 	/* TDI */
60 	int writeTDI(uint8_t *tx, uint8_t *rx, uint32_t len, bool end) override;
61 	/*!
62 	 * \brief toggle clock with static tms and tdi
63 	 * \param tms TMS state
64 	 * \param tdi TDI state
65 	 * \param clk_len number of clock cycle
66 	 * \return number of clock cycle
67 	 * */
68 	int toggleClk(uint8_t tms, uint8_t tdi, uint32_t clk_len) override;
69 
70 	/*!
71 	 * \brief return internal buffer size (in byte).
72 	 * \return _buffer_size divided by 2 (two byte for clk) and divided by 8 (one
73 	 * state == one byte)
74 	 */
get_buffer_size()75 	int get_buffer_size() override { return 63/8/2; }
76 
isFull()77 	bool isFull() override { return _nb_bit == 8*get_buffer_size();}
78 
79 	int flush() override;
80 
81  private:
82 	UsbBlaster_ll *ll_driver;
83 	int writeByte(uint8_t *tdo, int nb_byte);
84 	int writeBit(uint8_t *tdo, int nb_bit);
85 	int write(bool read, int rd_len);
86 	int setBitmode(uint8_t mode);
87 	uint8_t *_in_buf;
88 
89 	uint8_t _verbose;
90 	uint8_t _tck_pin; /*!< tck pin: 1 << pin id */
91 	uint8_t _tms_pin; /*!< tms pin: 1 << pin id */
92 	uint8_t _tdi_pin; /*!< tdi pin: 1 << pin id */
93 	int _nb_bit;
94 	uint8_t _curr_tms;
95 	uint16_t _buffer_size;
96 };
97 
98 /*!
99  * \file UsbBlaster.hpp
100  * \class UsbBlasterI
101  * \brief altera/intel low level usb blaster class for blasterI
102  * \author Gwenhael Goavec-Merou
103  */
104 class UsbBlasterI: public UsbBlaster_ll {
105 	public:
106 		UsbBlasterI();
107 		virtual ~UsbBlasterI();
108 
109 		int setClkFreq(uint32_t clkHZ) override;
110 		uint32_t getClkFreq() override;
111 		int write(uint8_t *wr_buf, int wr_len,
112 				uint8_t *rd_buf, int rd_len) override;
113 	private:
114 		/*
115 		 * \brief init and configure FT245
116 		 */
117 		void init_internal();
118 		struct ftdi_context *_ftdi; /*!< ftid_context */
119 };
120 
121 /*!
122  * \file UsbBlaster.hpp
123  * \class UsbBlasterII
124  * \brief altera/intel low level usb blaster class for blasterII
125  * \author Gwenhael Goavec-Merou
126  */
127 class UsbBlasterII: public UsbBlaster_ll {
128 	public:
129 		UsbBlasterII(const std::string &firmware_path);
130 		virtual ~UsbBlasterII();
131 
132 		int setClkFreq(uint32_t clkHZ) override;
133 		uint32_t getClkFreq() override;
134 		int write(uint8_t *wr_buf, int wr_len,
135 				uint8_t *rd_buf, int rd_len) override;
136 	private:
137 		FX2_ll *fx2;
138 };
139 #endif
140