Firmware
rm3100_main.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2015 PX4 Development Team. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * 3. Neither the name PX4 nor the names of its contributors may be
16  * used to endorse or promote products derived from this software
17  * without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
26  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
27  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  ****************************************************************************/
33 
38 #pragma once
39 
40 #include "rm3100.h"
41 
42 namespace rm3100
43 {
48  RM3100_BUS bus_id;
49  const char *devpath;
50  RM3100_constructor interface_constructor;
51  uint8_t busnum;
52  RM3100 *dev;
53 } bus_options[] = {
54 #ifdef PX4_I2C_BUS_EXPANSION
55  { RM3100_BUS_I2C_EXTERNAL, "/dev/rm3100_ext", &RM3100_I2C_interface, PX4_I2C_BUS_EXPANSION, NULL },
56 #endif /* PX4_I2C_BUS_EXPANSION */
57 #ifdef PX4_I2C_BUS_EXPANSION1
58  { RM3100_BUS_I2C_EXTERNAL, "/dev/rm3100_ext1", &RM3100_I2C_interface, PX4_I2C_BUS_EXPANSION1, NULL },
59 #endif /* PX4_I2C_BUS_EXPANSION1 */
60 #ifdef PX4_I2C_BUS_EXPANSION2
61  { RM3100_BUS_I2C_EXTERNAL, "/dev/rm3100_ext2", &RM3100_I2C_interface, PX4_I2C_BUS_EXPANSION2, NULL },
62 #endif /* PX4_I2C_BUS_EXPANSION2 */
63 #ifdef PX4_I2C_BUS_ONBOARD
64  { RM3100_BUS_I2C_INTERNAL, "/dev/rm3100_int", &RM3100_I2C_interface, PX4_I2C_BUS_ONBOARD, NULL },
65 #endif /* PX4_I2C_BUS_ONBOARD */
66 #ifdef PX4_SPIDEV_RM
67  { RM3100_BUS_SPI_INTERNAL, "/dev/rm3100_spi_int", &RM3100_SPI_interface, PX4_SPI_BUS_SENSORS, NULL },
68 #endif /* PX4_SPIDEV_RM */
69 #ifdef PX4_SPIDEV_RM_EXT
70  { RM3100_BUS_SPI_EXTERNAL, "/dev/rm3100_spi_ext", &RM3100_SPI_interface, PX4_SPI_BUS_EXT, NULL },
71 #endif /* PX4_SPIDEV_RM_EXT */
72 };
73 
77 rm3100_bus_option &find_bus(RM3100_BUS bus_id);
78 
82 int info(RM3100_BUS bus_id);
83 
87 bool init(RM3100_BUS bus_id);
88 
92 bool reset(RM3100_BUS bus_id);
93 
97 bool start_bus(struct rm3100_bus_option &bus, Rotation rotation);
98 
103 int start(RM3100_BUS bus_id, Rotation rotation);
104 
108 int stop();
109 
115 bool test(RM3100_BUS bus_id);
116 
120 void usage();
121 
122 } // namespace RM3100
Definition: rm3100_main.h:42
Rotation
Enum for board and external compass rotations.
Definition: rotation.h:51
Definition: rm3100.h:120
Definition: rm3100_main.h:47
Shared defines for the RM3100 driver.