2 * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3 * Copyright © 2014 Intel Corporation
5 * Permission is hereby granted, free of charge, to any person obtaining a copy
6 * of this software and associated documentation files (the "Software"), to
7 * deal in the Software without restriction, including without limitation the
8 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
9 * sell copies of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
12 * The above copyright notice and this permission notice shall be included in
13 * all copies or substantial portions of the Software.
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
28 * This file defines the basic shared types for libmraa
29 * this file is different to common.h in that swig takes this as an input
37 * MRAA supported platform types
40 MRAA_INTEL_GALILEO_GEN1 = 0, /**< The Generation 1 Galileo platform (RevD) */
41 MRAA_INTEL_GALILEO_GEN2 = 1, /**< The Generation 2 Galileo platform (RevG/H) */
42 MRAA_INTEL_EDISON_FAB_C = 2, /**< The Intel Edison (FAB C) */
43 MRAA_INTEL_DE3815 = 3, /**< The Intel DE3815 Baytrail NUC */
44 MRAA_INTEL_MINNOWBOARD_MAX = 4, /**< The Intel Minnow Board Max */
45 MRAA_RASPBERRY_PI = 5, /**< The different Raspberry PI Models -like A,B,A+,B+ */
46 MRAA_BEAGLEBONE = 6, /**< The different BeagleBone Black Modes B/C */
47 MRAA_BANANA = 7, /**< Allwinner A20 based Banana Pi and Banana Pro */
48 MRAA_INTEL_NUC5 = 8, /**< The Intel 5th generations Broadwell NUCs */
50 // USB platform extenders start at 256
51 MRAA_FTDI_FT4222 = 256, /**< FTDI FT4222 USB to i2c bridge */
53 MRAA_NULL_PLATFORM = 98, /**< Platform with no capabilities that hosts a sub platform */
54 MRAA_UNKNOWN_PLATFORM =
55 99 /**< An unknown platform type, typically will load INTEL_GALILEO_GEN1 */
59 * Intel edison miniboard numbering enum
62 MRAA_INTEL_EDISON_MINIBOARD_J17_1 = 0,
63 MRAA_INTEL_EDISON_MINIBOARD_J17_5 = 4,
64 MRAA_INTEL_EDISON_MINIBOARD_J17_7 = 6,
65 MRAA_INTEL_EDISON_MINIBOARD_J17_8 = 7,
66 MRAA_INTEL_EDISON_MINIBOARD_J17_9 = 8,
67 MRAA_INTEL_EDISON_MINIBOARD_J17_10 = 9,
68 MRAA_INTEL_EDISON_MINIBOARD_J17_11 = 10,
69 MRAA_INTEL_EDISON_MINIBOARD_J17_12 = 11,
70 MRAA_INTEL_EDISON_MINIBOARD_J17_14 = 13,
71 MRAA_INTEL_EDISON_MINIBOARD_J18_1 = 14,
72 MRAA_INTEL_EDISON_MINIBOARD_J18_2 = 15,
73 MRAA_INTEL_EDISON_MINIBOARD_J18_6 = 19,
74 MRAA_INTEL_EDISON_MINIBOARD_J18_7 = 20,
75 MRAA_INTEL_EDISON_MINIBOARD_J18_8 = 21,
76 MRAA_INTEL_EDISON_MINIBOARD_J18_10 = 23,
77 MRAA_INTEL_EDISON_MINIBOARD_J18_11 = 24,
78 MRAA_INTEL_EDISON_MINIBOARD_J18_12 = 25,
79 MRAA_INTEL_EDISON_MINIBOARD_J18_13 = 26,
80 MRAA_INTEL_EDISON_MINIBOARD_J19_4 = 31,
81 MRAA_INTEL_EDISON_MINIBOARD_J19_5 = 32,
82 MRAA_INTEL_EDISON_MINIBOARD_J19_6 = 33,
83 MRAA_INTEL_EDISON_MINIBOARD_J19_8 = 35,
84 MRAA_INTEL_EDISON_MINIBOARD_J19_9 = 36,
85 MRAA_INTEL_EDISON_MINIBOARD_J19_10 = 37,
86 MRAA_INTEL_EDISON_MINIBOARD_J19_11 = 38,
87 MRAA_INTEL_EDISON_MINIBOARD_J19_12 = 39,
88 MRAA_INTEL_EDISON_MINIBOARD_J19_13 = 40,
89 MRAA_INTEL_EDISON_MINIBOARD_J19_14 = 41,
90 MRAA_INTEL_EDISON_MINIBOARD_J20_3 = 44,
91 MRAA_INTEL_EDISON_MINIBOARD_J20_4 = 45,
92 MRAA_INTEL_EDISON_MINIBOARD_J20_5 = 46,
93 MRAA_INTEL_EDISON_MINIBOARD_J20_6 = 47,
94 MRAA_INTEL_EDISON_MINIBOARD_J20_7 = 48,
95 MRAA_INTEL_EDISON_MINIBOARD_J20_8 = 49,
96 MRAA_INTEL_EDISON_MINIBOARD_J20_9 = 50,
97 MRAA_INTEL_EDISON_MINIBOARD_J20_10 = 51,
98 MRAA_INTEL_EDISON_MINIBOARD_J20_11 = 52,
99 MRAA_INTEL_EDISON_MINIBOARD_J20_12 = 53,
100 MRAA_INTEL_EDISON_MINIBOARD_J20_13 = 54,
101 MRAA_INTEL_EDISON_MINIBOARD_J20_14 = 55
102 } mraa_intel_edison_miniboard_t;
105 * Intel Edison raw GPIO numbering enum
108 MRAA_INTEL_EDISON_GP182 = 0,
109 MRAA_INTEL_EDISON_GP135 = 4,
110 MRAA_INTEL_EDISON_GP27 = 6,
111 MRAA_INTEL_EDISON_GP20 = 7,
112 MRAA_INTEL_EDISON_GP28 = 8,
113 MRAA_INTEL_EDISON_GP111 = 0,
114 MRAA_INTEL_EDISON_GP109 = 10,
115 MRAA_INTEL_EDISON_GP115 = 11,
116 MRAA_INTEL_EDISON_GP128 = 13,
117 MRAA_INTEL_EDISON_GP13 = 14,
118 MRAA_INTEL_EDISON_GP165 = 15,
119 MRAA_INTEL_EDISON_GP19 = 19,
120 MRAA_INTEL_EDISON_GP12 = 20,
121 MRAA_INTEL_EDISON_GP183 = 21,
122 MRAA_INTEL_EDISON_GP110 = 23,
123 MRAA_INTEL_EDISON_GP114 = 24,
124 MRAA_INTEL_EDISON_GP129 = 25,
125 MRAA_INTEL_EDISON_GP130 = 26,
126 MRAA_INTEL_EDISON_GP44 = 31,
127 MRAA_INTEL_EDISON_GP46 = 32,
128 MRAA_INTEL_EDISON_GP48 = 33,
129 MRAA_INTEL_EDISON_GP131 = 35,
130 MRAA_INTEL_EDISON_GP14 = 36,
131 MRAA_INTEL_EDISON_GP40 = 37,
132 MRAA_INTEL_EDISON_GP43 = 38,
133 MRAA_INTEL_EDISON_GP77 = 39,
134 MRAA_INTEL_EDISON_GP82 = 40,
135 MRAA_INTEL_EDISON_GP83 = 41,
136 MRAA_INTEL_EDISON_GP134 = 44,
137 MRAA_INTEL_EDISON_GP45 = 45,
138 MRAA_INTEL_EDISON_GP47 = 46,
139 MRAA_INTEL_EDISON_GP49 = 47,
140 MRAA_INTEL_EDISON_GP15 = 48,
141 MRAA_INTEL_EDISON_GP84 = 49,
142 MRAA_INTEL_EDISON_GP42 = 50,
143 MRAA_INTEL_EDISON_GP41 = 51,
144 MRAA_INTEL_EDISON_GP78 = 52,
145 MRAA_INTEL_EDISON_GP79 = 53,
146 MRAA_INTEL_EDISON_GP80 = 54,
147 MRAA_INTEL_EDISON_GP81 = 55
148 } mraa_intel_edison_t;
151 * Raspberry PI Wiring compatible numbering enum
154 MRAA_RASPBERRY_WIRING_PIN8 = 3,
155 MRAA_RASPBERRY_WIRING_PIN9 = 5,
156 MRAA_RASPBERRY_WIRING_PIN7 = 7,
157 MRAA_RASPBERRY_WIRING_PIN15 = 8,
158 MRAA_RASPBERRY_WIRING_PIN16 = 10,
159 MRAA_RASPBERRY_WIRING_PIN0 = 11,
160 MRAA_RASPBERRY_WIRING_PIN1 = 12,
161 MRAA_RASPBERRY_WIRING_PIN2 = 13,
162 MRAA_RASPBERRY_WIRING_PIN3 = 15,
163 MRAA_RASPBERRY_WIRING_PIN4 = 16,
164 MRAA_RASPBERRY_WIRING_PIN5 = 18,
165 MRAA_RASPBERRY_WIRING_PIN12 = 19,
166 MRAA_RASPBERRY_WIRING_PIN13 = 21,
167 MRAA_RASPBERRY_WIRING_PIN6 = 22,
168 MRAA_RASPBERRY_WIRING_PIN14 = 23,
169 MRAA_RASPBERRY_WIRING_PIN10 = 24,
170 MRAA_RASPBERRY_WIRING_PIN11 = 26,
171 MRAA_RASPBERRY_WIRING_PIN17 = 29, // RPi B V2
172 MRAA_RASPBERRY_WIRING_PIN21 = 29,
173 MRAA_RASPBERRY_WIRING_PIN18 = 30, // RPi B V2
174 MRAA_RASPBERRY_WIRING_PIN19 = 31, // RPI B V2
175 MRAA_RASPBERRY_WIRING_PIN22 = 31,
176 MRAA_RASPBERRY_WIRING_PIN20 = 32, // RPi B V2
177 MRAA_RASPBERRY_WIRING_PIN26 = 32,
178 MRAA_RASPBERRY_WIRING_PIN23 = 33,
179 MRAA_RASPBERRY_WIRING_PIN24 = 35,
180 MRAA_RASPBERRY_WIRING_PIN27 = 36,
181 MRAA_RASPBERRY_WIRING_PIN25 = 37,
182 MRAA_RASPBERRY_WIRING_PIN28 = 38,
183 MRAA_RASPBERRY_WIRING_PIN29 = 40
184 } mraa_raspberry_wiring_t;
190 MRAA_SUCCESS = 0, /**< Expected response */
191 MRAA_ERROR_FEATURE_NOT_IMPLEMENTED = 1, /**< Feature TODO */
192 MRAA_ERROR_FEATURE_NOT_SUPPORTED = 2, /**< Feature not supported by HW */
193 MRAA_ERROR_INVALID_VERBOSITY_LEVEL = 3, /**< Verbosity level wrong */
194 MRAA_ERROR_INVALID_PARAMETER = 4, /**< Parameter invalid */
195 MRAA_ERROR_INVALID_HANDLE = 5, /**< Handle invalid */
196 MRAA_ERROR_NO_RESOURCES = 6, /**< No resource of that type avail */
197 MRAA_ERROR_INVALID_RESOURCE = 7, /**< Resource invalid */
198 MRAA_ERROR_INVALID_QUEUE_TYPE = 8, /**< Queue type incorrect */
199 MRAA_ERROR_NO_DATA_AVAILABLE = 9, /**< No data available */
200 MRAA_ERROR_INVALID_PLATFORM = 10, /**< Platform not recognised */
201 MRAA_ERROR_PLATFORM_NOT_INITIALISED = 11, /**< Board information not initialised */
202 MRAA_ERROR_PLATFORM_ALREADY_INITIALISED = 12, /**< Board is already initialised */
204 MRAA_ERROR_UNSPECIFIED = 99 /**< Unknown Error */
208 * Enum representing different possible modes for a pin.
211 MRAA_PIN_VALID = 0, /**< Pin Valid */
212 MRAA_PIN_GPIO = 1, /**< General Purpose IO */
213 MRAA_PIN_PWM = 2, /**< Pulse Width Modulation */
214 MRAA_PIN_FAST_GPIO = 3, /**< Faster GPIO */
215 MRAA_PIN_SPI = 4, /**< SPI */
216 MRAA_PIN_I2C = 5, /**< I2C */
217 MRAA_PIN_AIO = 6, /**< Analog in */
218 MRAA_PIN_UART = 7 /**< UART */
222 * Enum reprensenting different i2c speeds/modes
225 MRAA_I2C_STD = 0, /**< up to 100Khz */
226 MRAA_I2C_FAST = 1, /**< up to 400Khz */
227 MRAA_I2C_HIGH = 2 /**< up to 3.4Mhz */
231 MRAA_UART_PARITY_NONE = 0,
232 MRAA_UART_PARITY_EVEN = 1,
233 MRAA_UART_PARITY_ODD = 2,
234 MRAA_UART_PARITY_MARK = 3,
235 MRAA_UART_PARITY_SPACE = 4
236 } mraa_uart_parity_t;