1 #ifndef __CHDK_PTP_H 2 #define __CHDK_PTP_H 3 4 // CHDK PTP protocol interface (can also be used in client PTP programs) 5 6 // Note: used in modules and platform independent code. 7 // Do not add platform dependent stuff in here (#ifdef/#endif compile options or camera dependent values) 8 9 #define PTP_CHDK_VERSION_MAJOR 2 // increase only with backwards incompatible changes (and reset minor) 10 #define PTP_CHDK_VERSION_MINOR 9 // increase with extensions of functionality 11 // minor > 1000 for development versions 12 13 /* 14 protocol version history 15 0.1 - initial proposal from mweerden, + luar 16 0.2 - Added ScriptStatus and ScriptSupport, based on work by ultimA 17 1.0 - removed old script result code (luar), replace with message system 18 2.0 - return PTP_CHDK_TYPE_TABLE for tables instead of TYPE_STRING, allow return of empty strings 19 2.1 - experimental live view, not formally released 20 2.2 - live view (work in progress) 21 2.3 - live view - released in 1.1 22 2.4 - live view protocol 2.1 23 2.5 - remote capture 24 2.6 - script execution flags 25 2.7 - live view protocol 2.2 26 2.8 - GetMemory extensions 27 2.9 - Canon raw remote capture 28 */ 29 30 #define PTP_OC_CHDK 0x9999 31 32 // N.B.: unused parameters should be set to 0 33 enum ptp_chdk_command { 34 PTP_CHDK_Version = 0, // return param1 is major version number 35 // return param2 is minor version number 36 PTP_CHDK_GetMemory, // param2 is base address (direct may fail on MMIO etc. Use buffered for those) 37 // param3 is size (in bytes) 38 // param4 is options: 0 read directly, 1 buffer. Other values reserved 39 // return data is memory block 40 PTP_CHDK_SetMemory, // param2 is address 41 // param3 is size (in bytes) 42 // data is new memory block 43 PTP_CHDK_CallFunction, // data is array of function pointer and 32 bit int arguments (max: 10 args prior to protocol 2.5) 44 // return param1 is return value 45 PTP_CHDK_TempData, // data is data to be stored for later 46 // param2 is for the TD flags below 47 PTP_CHDK_UploadFile, // data is 4-byte length of filename, followed by filename and contents 48 PTP_CHDK_DownloadFile, // preceded by PTP_CHDK_TempData with filename 49 // return data are file contents 50 PTP_CHDK_ExecuteScript, // data is script to be executed 51 // param2 is language of script 52 // in proto 2.6 and later, language is the lower byte, rest is used for PTP_CHDK_SCRIPT_FL* flags 53 // return param1 is script id, like a process id 54 // return param2 is status from ptp_chdk_script_error_type 55 PTP_CHDK_ScriptStatus, // Script execution status 56 // return param1 bits 57 // PTP_CHDK_SCRIPT_STATUS_RUN is set if a script running, cleared if not 58 // PTP_CHDK_SCRIPT_STATUS_MSG is set if script messages from script waiting to be read 59 // all other bits and params are reserved for future use 60 PTP_CHDK_ScriptSupport, // Which scripting interfaces are supported in this build 61 // param1 CHDK_PTP_SUPPORT_LUA is set if lua is supported, cleared if not 62 // all other bits and params are reserved for future use 63 PTP_CHDK_ReadScriptMsg, // read next message from camera script system 64 // return param1 is chdk_ptp_s_msg_type 65 // return param2 is message subtype: 66 // for script return and users this is ptp_chdk_script_data_type 67 // for error ptp_chdk_script_error_type 68 // return param3 is script id of script that generated the message 69 // return param4 is length of the message data. 70 // return data is message. 71 // A minimum of 1 bytes of zeros is returned if the message has no data (empty string or type NONE) 72 PTP_CHDK_WriteScriptMsg, // write a message for scripts running on camera 73 // input param2 is target script id, 0=don't care. Messages for a non-running script will be discarded 74 // data length is handled by ptp data phase 75 // input messages do not have type or subtype, they are always a string destined for the script (similar to USER/string) 76 // output param1 is ptp_chdk_script_msg_status 77 PTP_CHDK_GetDisplayData, // Return camera display data 78 // This is defined as separate sub protocol in live_view.h 79 // Changes to the sub-protocol will always be considered a minor change to the main protocol 80 // param2 bitmask of data 81 // output param1 = total size of data 82 // return data is protocol information, frame buffer descriptions and selected display data 83 // Currently a data phase is always returned. Future versions may define other behavior 84 // for values in currently unused parameters. 85 // Direct image capture over USB. 86 // Use lua get_usb_capture_support for available data types, lua init_usb_capture for setup 87 PTP_CHDK_RemoteCaptureIsReady, // Check if data is available 88 // return param1 is status 89 // 0 = not ready 90 // 0x10000000 = remote capture not initialized 91 // otherwise bitmask of PTP_CHDK_CAPTURE_* datatypes 92 // return param2 is image number 93 PTP_CHDK_RemoteCaptureGetData // retrieve data 94 // param2 is bit indicating data type to get 95 // return param1 is length 96 // return param2 more chunks available? 97 // 0 = no more chunks of selected format 98 // return param3 seek required to pos (-1 = no seek) 99 }; 100 101 // data types as used by ReadScriptMessage 102 enum ptp_chdk_script_data_type { 103 PTP_CHDK_TYPE_UNSUPPORTED = 0, // type name will be returned in data 104 PTP_CHDK_TYPE_NIL, 105 PTP_CHDK_TYPE_BOOLEAN, 106 PTP_CHDK_TYPE_INTEGER, 107 PTP_CHDK_TYPE_STRING, // Empty strings are returned with length=0 108 PTP_CHDK_TYPE_TABLE, // tables are converted to a string by usb_msg_table_to_string, 109 // this function can be overridden in lua to change the format 110 // the string may be empty for an empty table 111 }; 112 113 // TempData flags 114 #define PTP_CHDK_TD_DOWNLOAD 0x1 // download data instead of upload 115 #define PTP_CHDK_TD_CLEAR 0x2 // clear the stored data; with DOWNLOAD this 116 // means first download, then clear and 117 // without DOWNLOAD this means no uploading, 118 // just clear 119 120 // Script Languages - for execution only lua is supported for now 121 #define PTP_CHDK_SL_LUA 0 122 #define PTP_CHDK_SL_UBASIC 1 123 #define PTP_CHDK_SL_MASK 0xFF 124 125 // bit flags for script start 126 #define PTP_CHDK_SCRIPT_FL_NOKILL 0x100 // if script is running return error instead of killing 127 #define PTP_CHDK_SCRIPT_FL_FLUSH_CAM_MSGS 0x200 // discard existing cam->host messages before starting 128 #define PTP_CHDK_SCRIPT_FL_FLUSH_HOST_MSGS 0x400 // discard existing host->cam messages before starting 129 130 // bit flags for script status 131 #define PTP_CHDK_SCRIPT_STATUS_RUN 0x1 // script running 132 #define PTP_CHDK_SCRIPT_STATUS_MSG 0x2 // messages waiting 133 // bit flags for scripting support 134 #define PTP_CHDK_SCRIPT_SUPPORT_LUA 0x1 135 136 137 // GetMemory modes 138 #define PTP_CHDK_GETMEM_MODE_DIRECT 0x0 // default, using Canon send_data (DMA), may fail on MMIO or TCM 139 #define PTP_CHDK_GETMEM_MODE_BUFFER 0x1 // buffered with memcpy, slower. May not be correct for MMIO but seems to work 140 141 // bit flags for remote capture 142 // used to select and also to indicate available data in PTP_CHDK_RemoteCaptureIsReady 143 /* 144 Full jpeg file. Note supported on all cameras, use Lua get_usb_capture_support to check 145 */ 146 #define PTP_CHDK_CAPTURE_JPG 0x1 147 148 /* 149 Raw framebuffer data, in camera native format. 150 A subset of rows may be requested in init_usb_capture. 151 */ 152 #define PTP_CHDK_CAPTURE_RAW 0x2 153 154 /* 155 DNG header. 156 The header will be DNG version 1.3 157 Does not include image data, clients wanting to create a DNG file should also request RAW 158 Raw data for all known cameras will be packed, little endian. Client is responsible for 159 reversing the byte order if creating a DNG. 160 Can requested without RAW to get sensor dimensions, exif values etc. 161 162 ifd 0 specifies a 128x96 RGB thumbnail, 4 byte aligned following the header 163 client is responsible for generating thumbnail data. 164 165 ifd 0 subifd 0 specifies the main image 166 The image dimensions always contain the full sensor dimensions, if a sub-image was requested 167 with init_usb_capture, the client is responsible for padding the data to the full image or 168 adjusting dimensions. 169 170 Bad pixels will not be patched, but DNG opcodes will specify how to patch them 171 */ 172 #define PTP_CHDK_CAPTURE_DNGHDR 0x4 173 174 /* 175 Canon raw - only on cameras with native raw support and filewrite hook 176 use Lua get_usb_capture_support to check 177 */ 178 #define PTP_CHDK_CAPTURE_CRAW 0x8 179 180 // status from PTP_CHDK_RemoteCaptureIsReady if capture not enabled 181 #define PTP_CHDK_CAPTURE_NOTSET 0x10000000 182 183 // message types 184 enum ptp_chdk_script_msg_type { 185 PTP_CHDK_S_MSGTYPE_NONE = 0, // no messages waiting 186 PTP_CHDK_S_MSGTYPE_ERR, // error message 187 PTP_CHDK_S_MSGTYPE_RET, // script return value 188 PTP_CHDK_S_MSGTYPE_USER, // message queued by script 189 // TODO chdk console data ? 190 }; 191 192 // error subtypes for PTP_CHDK_S_MSGTYPE_ERR and script startup status 193 enum ptp_chdk_script_error_type { 194 PTP_CHDK_S_ERRTYPE_NONE = 0, 195 PTP_CHDK_S_ERRTYPE_COMPILE, 196 PTP_CHDK_S_ERRTYPE_RUN, 197 // the following are for ExecuteScript status only, not message types 198 PTP_CHDK_S_ERR_SCRIPTRUNNING = 0x1000, // script already running with NOKILL 199 }; 200 201 // message status 202 enum ptp_chdk_script_msg_status { 203 PTP_CHDK_S_MSGSTATUS_OK = 0, // queued ok 204 PTP_CHDK_S_MSGSTATUS_NOTRUN, // no script is running 205 PTP_CHDK_S_MSGSTATUS_QFULL, // queue is full 206 PTP_CHDK_S_MSGSTATUS_BADID, // specified ID is not running 207 }; 208 209 #endif // __CHDK_PTP_H