CMake: bump the minimal required version to 3.5
[libftdi.git] / README.build
blobe130ca09f38325963bad59825442a8d0252164cf
1 Here is a short tutorial on how to build libftdi git under
2 Ubuntu 12.10, But it is similar on other Linux distros.
4 1) Install the build tools
5 sudo apt-get install build-essential (yum install make automake gcc gcc-c++ kernel-devel)
6 sudo apt-get install git-core (yum install git)
7 sudo apt-get install cmake (yum install cmake)
8 sudo apt-get install doxygen (for building documentations) (yum install doxygen)
10 2) Install dependencies
11 sudo apt-get install libusb-1.0-devel (yum install libusb-devel)
12 (if the system comes with older version like 1.0.8 or
13 earlier, it is recommended you build libusbx-1.0.14 or later).
15 sudo apt-get install libconfuse-dev (for ftdi-eeprom) (yum install libconfuse-devel)
16 sudo apt-get install swig python-dev (for python bindings) (yum install swig python-devel)
17 sudo apt-get install libboost-all-dev (for C++ binding and unit test) (yum install boost-devel)
19 3) Clone the git repository
20 mkdir libftdi
21 cd libftdi
22 git clone git://developer.intra2net.com/libftdi
24 If you are building the release tar ball, just extract the source
25 tar ball.
27 4) Build the git source and install
28 cd libftdi
29 mkdir build
30 cd build
31 cmake  -DCMAKE_INSTALL_PREFIX="/usr" ../
32 make
33 sudo make install
35 5) carry out some tests
36 cd examples
38 mcuee@Ubuntu1210VM:~/Desktop/build/libftdi/libftdi/build/examples$
39 ./find_all_pp  -v 0x0403 -p 0x6001
40 Found devices ( VID: 0x403, PID: 0x6001 )
41 ------------------------------------------------
42 FTDI (0x8730800): ftdi, usb serial converter, ftDEH51S (Open OK)
43 FTDI (0x8730918): FTDI, FT232R USB UART, A8007Ub5 (Open OK)
45 mcuee@Ubuntu1210VM:~/Desktop/build/libftdi/libftdi/build/examples$ ./eeprom
46 2 FTDI devices found: Only Readout on EEPROM done. Use
47 VID/PID/desc/serial to select device
48 Decoded values of device 1:
49 Chip type 1 ftdi_eeprom_size: 128
50 0x000: 00 00 03 04 01 60 00 04  a0 16 08 00 10 01 94 0a .....`.. ........
51 0x010: 9e 2a c8 12 0a 03 66 00  74 00 64 00 69 00 2a 03 .*....f. t.d.i.*.
52 0x020: 75 00 73 00 62 00 20 00  73 00 65 00 72 00 69 00 u.s.b. . s.e.r.i.
53 0x030: 61 00 6c 00 20 00 63 00  6f 00 6e 00 76 00 65 00 a.l. .c. o.n.v.e.
54 0x040: 72 00 74 00 65 00 72 00  12 03 66 00 74 00 44 00 r.t.e.r. ..f.t.D.
55 0x050: 45 00 48 00 35 00 31 00  53 00 02 03 00 00 00 00 E.H.5.1. S.......
56 0x060: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 ........ ........
57 0x070: 00 00 00 00 00 00 00 00  00 00 00 00 01 00 16 02 ........ ........
58 VID:     0x0403
59 PID:     0x6001
60 Release: 0x0400
61 Bus Powered:  44 mA USB Remote Wake Up
62 Manufacturer: ftdi
63 Product:      usb serial converter
64 Serial:       ftDEH51S
65 Checksum      : 0216
66 Enable Remote Wake Up
67 PNP: 1
68 Decoded values of device 2:
69 Chip type 3 ftdi_eeprom_size: 128
70 0x000: 00 40 03 04 01 60 00 00  a0 2d 08 00 00 00 98 0a .@...`.. .-......
71 0x010: a2 20 c2 12 23 10 05 00  0a 03 46 00 54 00 44 00 . ..#... ..F.T.D.
72 0x020: 49 00 20 03 46 00 54 00  32 00 33 00 32 00 52 00 I. .F.T. 2.3.2.R.
73 0x030: 20 00 55 00 53 00 42 00  20 00 55 00 41 00 52 00  .U.S.B.  .U.A.R.
74 0x040: 54 00 12 03 41 00 38 00  30 00 30 00 37 00 55 00 T...A.8. 0.0.7.U.
75 0x050: 62 00 35 00 c9 bf 1c 80  00 00 00 00 00 00 00 00 b.5..... ........
76 0x060: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 00 00 ........ ........
77 0x070: 00 00 00 00 00 00 00 00  00 00 00 00 00 00 0f 23 ........ .......#
78 0x080: 2c 04 d3 fb 00 00 c9 bf  1c 80 42 00 00 00 00 00 ,....... ..B.....
79 0x090: 00 00 00 00 00 00 00 00  38 41 32 52 4a 33 47 4f ........ 8A2RJ3GO
80 VID:     0x0403
81 PID:     0x6001
82 Release: 0x0000
83 Bus Powered:  90 mA USB Remote Wake Up
84 Manufacturer: FTDI
85 Product:      FT232R USB UART
86 Serial:       A8007Ub5
87 Checksum      : 230f
88 Internal EEPROM
89 Enable Remote Wake Up
90 PNP: 1
91 Channel A has Mode UART VCP
92 C0 Function: TXLED
93 C1 Function: RXLED
94 C2 Function: TXDEN
95 C3 Function: PWREN
96 C4 Function: SLEEP