PX4 Firmware
PX4 Autopilot Software http://px4.io
drv_blinkm.h
Go to the documentation of this file.
1 /****************************************************************************
2  *
3  * Copyright (c) 2012-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 
34 /**
35  * @file drv_blinkm.h
36  *
37  * BlinkM driver API
38  *
39  * This could probably become a more generalised API for multi-colour LED
40  * driver systems, or be merged with the generic LED driver.
41  */
42 
43 #pragma once
44 
45 #include <px4_platform_common/defines.h>
46 #include <stdint.h>
47 #include <sys/ioctl.h>
48 
49 #define BLINKM0_DEVICE_PATH "/dev/blinkm0"
50 
51 /*
52  * ioctl() definitions
53  */
54 
55 #define _BLINKMIOCBASE (0x2900)
56 #define _BLINKMIOC(_n) (_PX4_IOC(_BLINKMIOCBASE, _n))
57 
58 /** play the named script in *(char *)arg, repeating forever */
59 #define BLINKM_PLAY_SCRIPT_NAMED _BLINKMIOC(1)
60 
61 /** play the numbered script in (arg), repeating forever */
62 #define BLINKM_PLAY_SCRIPT _BLINKMIOC(2)
63 
64 /**
65  * Set the user script; (arg) is a pointer to an array of script lines,
66  * where each line is an array of four bytes giving <duration>, <command>, arg[0-2]
67  *
68  * The script is terminated by a zero command.
69  */
70 #define BLINKM_SET_USER_SCRIPT _BLINKMIOC(3)