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_DEVINFO = 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_MIDDLE = 2,
  47         AM7XXX_POWER_HIGH   = 3,
  48         AM7XXX_POWER_TURBO  = 4,
  49 } am7xxx_power_mode;
  50
  51 struct am7xxx_generic_header {
  52         uint32_t field0;
  53         uint32_t field1;
  54         uint32_t field2;
  55         uint32_t field3;
  56 };
  57
  58 struct am7xxx_devinfo_header {
  59         uint32_t native_width;
  60         uint32_t native_height;
  61         uint32_t unknown0;
  62         uint32_t unknown1;
  63 };
  64
  65 struct am7xxx_image_header {
  66         uint32_t format;
  67         uint32_t width;
  68         uint32_t height;
  69         uint32_t image_size;
  70 };
  71
  72 struct am7xxx_power_header {
  73         uint32_t bit2;
  74         uint32_t bit1;
  75         uint32_t bit0;
  76 };
  77
  78 /*
  79  * Examples of packet headers:
  80  *
  81  * Image header:
  82  * 02 00 00 00 00 10 3e 10 01 00 00 00 20 03 00 00 e0 01 00 00 53 E8 00 00
  83  *
  84  * Power header:
  85  * 04 00 00 00 00 0c ff ff 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
  86  */
  87
  88 /* The header size on the wire is known to be always 24 bytes, regardless of
  89  * the memory configuration enforced by different architechtures or compilers
  90  * for struct am7xxx_header
  91  */
  92 #define AM7XXX_HEADER_WIRE_SIZE 24
  93
  94 struct am7xxx_header {
  95         uint32_t packet_type;
  96         uint8_t unknown0;
  97         uint8_t header_data_len;
  98         uint8_t unknown2;
  99         uint8_t unknown3;
 100         union {
 101                 struct am7xxx_generic_header data;
 102                 struct am7xxx_devinfo_header devinfo;
 103                 struct am7xxx_image_header image;
 104                 struct am7xxx_power_header power;
 105         } header_data;
 106 };
 107
 108 am7xxx_device am7xxx_init(void);
 109
 110 void am7xxx_shutdown(am7xxx_device dev);
 111
 112 int am7xxx_get_device_info(am7xxx_device dev,
 113                            unsigned int *native_width,
 114                            unsigned int *native_height,
 115                            unsigned int *unknown0,
 116                            unsigned int *unknown1);
 117
 118 int am7xxx_send_image(am7xxx_device dev,
 119                       am7xxx_image_format format,
 120                       unsigned int width,
 121                       unsigned int height,
 122                       uint8_t *image,
 123                       unsigned int size);
 124
 125 /*
 126  * NOTE: if we set the mode to AM7XXX_POWER_OFF we can't turn the
 127  * display on again by using only am7xxx_set_power_mode().
 128  *
 129  * Remember to mention that when writing the API doc.
 130  */
 131 int am7xxx_set_power_mode(am7xxx_device dev, am7xxx_power_mode mode);
 132
 133 #ifdef __cplusplus
 134 }
 135 #endif
 136
 137 #endif /* __AM7XXX_H */