raspberry pi: add doc for model b
[contrib/mraa.git] / docs / edison.md
1 Intel Edison                            {#edison}
2 =============
3
4 Intel(R) Edison is a dual core Silvermont Atom(TM) clocked at 500MHz. The
5 Edison also features 4GB of storage, 1GB ram and onboard wifi and bluetooth.
6
7 Currently Supported boards:
8 - Intel Arduino board
9 - Intel breakout board
10
11 UART
12 ----
13 On both the Arduino board and the breakout board, The avaible UART interface is on /dev/ttyMFD1
14
15 Intel Arduino board
16 -------------------
17 The Edison used with the Arduino board has the following limitations
18 in libmraa:
19
20 - i2c is exposed on i2c-6, therfore you must use bus 6 and not bus 0
21 - PWM avaible on default swizzler postions. (3,5,6,9)
22 - SPI exposed is also used for the ADC. Try not to use your own CS.
23 - ADC kernel module will return 12bit number but the ADC itself only has an
24   accuracy of 10bits. This ADC is only included on the arduino board.
25 - AIO pins are treated as 0-5 in mraa_aio_init() but as 14-19 for everything
26   else. Therefore use mraa_gpio_init(14) to use A0 as a Gpio
27
28 Intel(R) breakout board
29 -----------------------
30
31 - Both I2C buses are avaible 1 & 6
32 - IO on the miniboard is 1.8V
33
34 Please see the following table on how the physical pins map to mraa pin numbers
35
36 | MRAA Number | Physical Pin | Edison Pin    | Notes                   | Pinmode0 | Pinmode1   | Pinmode2 |
37 |-------------|--------------|---------------|-------------------------|----------|------------|----------|
38 | 0           | J17-1        | GP182         |                         | GPIO-182 | PWM2       |          |
39 | 1           | J17-2        | NC            | Nothing from mraa       |          |            |          |
40 | 2           | J17-3        | NC            | Nothing from mraa       |          |            |          |
41 | 3           | J17-4        | VIN           | Nothing from mraa       |          |            |          |
42 | 4           | J17-5        | GP135         |                         | GPIO-135 | UART       |          |
43 | 5           | J17-6        | RCVR_MODE     | Nothing from mraa       |          |            |          |
44 | 6           | J17-7        | GP27          |                         | GPIO-27  | I2C-6-SCL  |          |
45 | 7           | J17-8        | GP20          |                         | GPIO-20  | I2C-1-SDA  |          |
46 | 8           | J17-9        | GP28          |                         | GPIO-28  | I2C-6-SDA  |          |
47 | 9           | J17-10       | GP111         |                         | GPIO-111 | SPI-5-CS1  |          |
48 | 10          | J17-11       | GP109         |                         | GPIO-109 | SPI-5-SCK  |          |
49 | 11          | J17-12       | GP115         |                         | GPIO-115 | SPI-5-MOSI |          |
50 | 12          | J17-13       | OSC_CLK_OUT_0 | Nothing from mraa/check |          |            |          |
51 | 13          | J17-14       | GP128         |                         | GPIO-128 | UART-1-CTS |          |
52 | 14          | J18-1        | GP13          |                         | GPIO-13  | PWM1       |          |
53 | 15          | J18-2        | GP165         |                         | GPIO-165 |            |          |
54 | 16          | J18-3        | GPI_PWRBTN_N  | Nothing from mraa       |          |            |          |
55 | 17          | J18-4        | MSIC_SLP_CLK2 | Nothing from mraa       |          |            |          |
56 | 18          | J18-5        | V_VBAT_BKUP   | Nothing from mraa       |          |            |          |
57 | 19          | J18-6        | GP19          |                         | GPIO-19  | I2C-1-SCL  |          |
58 | 20          | J18-7        | GP12          | PWM0                    | GPIO-12  | PWM0       |          |
59 | 21          | J18-8        | GP183         | PWM3                    | GPIO-183 | PWM3       |          |
60 | 22          | J18-9        | NC            | Nothing from mraa       |          |            |          |
61 | 23          | J18-10       | GP110         |                         | GPIO-110 | SPI-5-CS0  |          |
62 | 24          | J18-11       | GP114         |                         | GPIO-114 | SPI-5-MISO |          |
63 | 25          | J18-12       | GP129         |                         | GPIO-129 | UART-1-RTS |          |
64 | 26          | J18-13       | GP130         |                         | GPIO-130 | UART-1-RX  |          |
65 | 27          | J18-14       | FW_RCVR       | Nothing from mraa       |          |            |          |
66 | 28          | J19-1        | NC            | Nothing from mraa       |          |            |          |
67 | 29          | J19-2        | V_V1P80       | Nothing from mraa       |          |            |          |
68 | 30          | J19-3        | GND           | Nothing from mraa       |          |            |          |
69 | 31          | J19-4        | GP44          |                         | GPIO-44  |            |          |
70 | 32          | J19-5        | GP46          |                         | GPIO-46  |            |          |
71 | 33          | J19-6        | GP48          |                         | GPIO-48  |            |          |
72 | 34          | J19-7        | RESET_OUT     | Nothing from mraa       |          |            |          |
73 | 35          | J19-8        | GP131         |                         | GPIO-131 | UART-1-TX  |          |
74 | 36          | J19-9        | GP14          |                         | GPIO-14  |            |          |
75 | 37          | J19-10       | GP40          |                         | GPIO-40  | SSP2_CLK   |          |
76 | 38          | J19-11       | GP43          |                         | GPIO-43  | SSP2_TXD   |          |
77 | 39          | J19-12       | GP77          |                         | GPIO-77  | SD         |          |
78 | 40          | J19-13       | GP82          |                         | GPIO-82  | SD         |          |
79 | 41          | J19-14       | GP83          |                         | GPIO-83  | SD         |          |
80 | 42          | J20-1        | V_VSYS        | Nothing from mraa       |          |            |          |
81 | 43          | J20-2        | V_V3P30       | Nothing from mraa       |          |            |          |
82 | 44          | J20-3        | GP134         |                         |          |            |          |
83 | 45          | J20-4        | GP45          |                         | GPIO-45  |            |          |
84 | 46          | J20-5        | GP47          |                         | GPIO-47  |            |          |
85 | 47          | J20-6        | GP49          |                         | GPIO-49  |            |          |
86 | 48          | J20-7        | GP15          |                         | GPIO-15  |            |          |
87 | 49          | J20-8        | GP84          |                         | GPIO-84  | SD         |          |
88 | 50          | J20-9        | GP42          |                         | GPIO-42  | SSP2_RXD   |          |
89 | 51          | J20-10       | GP41          |                         | GPIO-41  | SSP2_FS    |          |
90 | 52          | J20-11       | GP78          |                         | GPIO-78  | SD         |          |
91 | 53          | J20-12       | GP79          |                         | GPIO-79  | SD         |          |
92 | 54          | J20-13       | GP80          |                         | GPIO-80  | SD         |          |
93 | 55          | J20-14       | GP81          |                         | GPIO-81  | SD         |          |