Dump the data only in DEBUG builds
[libam7xxx.git] / src / am7xxx.h
1 /* am7xxx - communication with AM7XXX based USB Pico Projectors and DPFs
2  *
3  * Copyright (C) 2012  Antonio Ospite <ospite@studenti.unina.it>
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifndef __AM7XXX_H
20 #define __AM7XXX_H
21
22 #include <stdint.h>
23 #include <libusb-1.0/libusb.h>
24
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28
29 typedef libusb_device_handle *am7xxx_device;
30
31 typedef enum {
32         AM7XXX_PACKET_TYPE_INIT    = 0x01,
33         AM7XXX_PACKET_TYPE_IMAGE   = 0x02,
34         AM7XXX_PACKET_TYPE_POWER   = 0x04,
35         AM7XXX_PACKET_TYPE_UNKNOWN = 0x05,
36 } am7xxx_packet_type;
37
38 typedef enum {
39         AM7XXX_IMAGE_FORMAT_JPEG = 1,
40         AM7XXX_IMAGE_FORMAT_NV12 = 2,
41 } am7xxx_image_format;
42
43 typedef enum {
44         AM7XXX_POWER_OFF  = 0,
45         AM7XXX_POWER_LOW  = 1,
46         AM7XXX_POWER_MID  = 2,
47         AM7XXX_POWER_HIGH = 3,
48 } am7xxx_power_mode;
49
50 struct am7xxx_generic_header {
51         uint32_t field0;
52         uint32_t field1;
53         uint32_t field2;
54         uint32_t field3;
55 };
56
57 struct am7xxx_image_header {
58         uint32_t format;
59         uint32_t width;
60         uint32_t height;
61         uint32_t image_size;
62 };
63
64 struct am7xxx_power_header {
65         uint32_t power_low;
66         uint32_t power_mid;
67         uint32_t power_high;
68 };
69
70 /*
71  * Examples of packet headers:
72  *
73  * Image header:
74  * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
75  *
76  * Power header:
77  * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
78  */
79
80 /* The header size on the wire is known to be always 24 bytes, regardless of
81  * the memory configuration enforced by different architechtures or compilers
82  * for struct am7xxx_header
83  */
84 #define AM7XXX_HEADER_WIRE_SIZE 24
85
86 struct am7xxx_header {
87         uint32_t packet_type;
88         uint8_t unknown0;
89         uint8_t header_data_len;
90         uint8_t unknown2;
91         uint8_t unknown3;
92         union {
93                 struct am7xxx_generic_header data;
94                 struct am7xxx_image_header image;
95                 struct am7xxx_power_header power;
96         } header_data;
97 };
98
99 am7xxx_device am7xxx_init(void);
100
101 void am7xxx_shutdown(am7xxx_device dev);
102
103 int am7xxx_send_image(am7xxx_device dev,
104                       am7xxx_image_format format,
105                       unsigned int width,
106                       unsigned int height,
107                       uint8_t *image,
108                       unsigned int size);
109
110 #ifdef __cplusplus
111 }
112 #endif
113
114 #endif /* __AM7XXX_H */