VDCP_Protocol_2003

HARRIS CORPORATION | B r oa dcas t Co m m un ica t i ons D i v i s i o n a s s u r e dco m mun i c a t i ons ™ V DCP P ro t oc o l Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 VDCP Protocol 24-February-2003 V DCP P ro t oc o l © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 2 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Copyright Information © 2003-2009 Harris Corporation. All rights reserved. Harris Proprietary Information. All information contained in or disclosed by this document is considered confidential and proprietary by Harris Corporation. Harris Corporation reserves the right to use this design in other projects without reference to the recipient. By accepting this material, the recipient agrees that this material and the information contained therein will be held in confidence and in trust and will not be copied or disclosed in whole or in part to any third party. Warranty Notice HARRIS CORPORATION MAKES NO WARRANTY, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, REGARDING THESE MATERIALS AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON AN “AS-IS” BASIS. IN NO EVENT SHALL HARRIS CORPORATION BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE OR USE OF THESE MATERIALS. This publication is designed to assist in the use of the product as it exists on the date of publication of this manual, and may not reflect the product at the current time or an unknown time in the future. This publication does not in any way warrant description accuracy or guarantee the use for the product to which it refers. Permissions and Reproductions This publication, or any part thereof, may not be reproduced in any form, by any method, for any purpose, without the written consent of Harris Corporation. Contact Harris Corporation for permission to use materials as well as guidelines concerning foreign language translation and publication. A reasonable number of copies of this document may be printed for internal use only. All others uses are illegal. Notice of Change Harris Corporation reserves the right, without notice to make such changes in equipment, design, specifications, components, or documentation as progress may warrant to improve the performance of the product. Trademarks The Harris logo, assuredcommunications™ and ADC™ are trademarks of Harris Corporation or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. All other marks are the property of their respective owners. Contact Information Contact Harris Corporation at: The Americas Englewood office 9800 S. Meridian Blvd Englewood, CO 80112 USA Ph +1 303 476 5000 Fax +1 303 476 5004 Sunnyvale office V DCP P ro t oc o l © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 3 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 1134 E. Arques Avenue Sunnyvale, CA 94085 USA Ph +1 (408) 990-8200 Europe, Asia, Africa England Eskdale Road Winnersh Triangle Reading, Berkshire England RG41 5TS Ph +44 (0) 118 9648000 France Immeuble Athena 23 Boulevard de l’Oise 95031 Cergy-Pontoise, France Ph +33 1 30 38 08 04 Fax +33 1 30 38 08 76 Australia/Pacific Level 1, 14 Rodborough Road, Frenchs Forest NSW 2086 Australia Ph +61 (2) 9975 9700 Fax +61 (2) 9975 3519 V DCP P ro t oc o l Co n t en t s © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 4 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Contents CHANGE TABLE................................................................................ 5 VIDEO DISK COMMUNICATIONS PROTOCOL ............................. 10 General...................................................................................................................................... 10 Electrical and Mechanical Specifications1................................................................................. 10 Session Specification ................................................................................................................ 11 Immediate Command............................................................................................................ 12 Preset/Select Command....................................................................................................... 13 Sense Request ..................................................................................................................... 13 Deferred (Timeline) Command ............................................................................................. 14 IDs ............................................................................................................................................. 15 Macros....................................................................................................................................... 16 VIDEO DISK COMMAND TABLE..................................................... 18 COMMAND DESCRIPTION............................................................. 22 General...................................................................................................................................... 22 System Commands................................................................................................................... 23 Immediate Commands .............................................................................................................. 24 Preset/Select Commands ......................................................................................................... 27 Sense Requests ........................................................................................................................ 37 Port Status Data Description..................................................................................................... 40 Macro Commands..................................................................................................................... 53 APPENDIX 1 .................................................................................... 58 Use of the Protocol with Hardware Buffers ............................................................................... 58 V DCP P ro t oc o l 0 B C HA N GE T AB L E © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 5 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 CHANGE TABLE Revised 2/24/03 Added 2X.67, 3X.67 ASI Program Number commands. Revised 08/04/00 Added to Command Table the Variable Length ID commands 8X, AX, BX, DX Added 3X.05 PORT STATUS extended option for status fields 2 and 3 Modified 3X.06 POSITION REQUEST description to make it clearer Added 3X.10 SYSTEM STATUS extended option for status fields 1 and 2 Modified 3X.16 ID REQUEST response options to remove ambiguity and to add optional byte to specify handle specifying node Revised 10/19/99 Modified RETURN DATA Bit Map in ID REQUEST (3X.16) box so Video Type section references Video Type Definition. Revised 10/7/98 Added 3X.05 Command Queue Full and Network Error to Port Error Status Added optional Tape ID to 0X.14 Delete From Archive command Revised 1/29/98 Added 5X optional Macros and related commands Added 3X.16 Optional byte and bits in ID Request Added 3X.10 Notes on Largest Contiguous Block in System Status Added 8X, AX, BX, DX Variable Length ID commands Added optional data in 1X.07 command, define data type Added a Variable Play bit in the Port Status 3X.05 Change Command Execution timing requirements Added Video Type Bit in ID Request and Port Status Added 5X.66 Prepare ID To Play command Added 5X.67 Close ID From Play command Added Optional data to 10.01 Play command Added Optional data to 2X.24 Cue command V DCP P ro t oc o l 0 B C HA N GE T AB L E © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 6 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Revised 3/28/97 Modify 2X.27 GET FROM ARCHIVE command supporting detail Modify 2X.2A SEND TO ARCHIVE command supporting detail Modify 2X.50 rename MOVE FILE to COPY FILE TO command Modify 2X.51 rename DELETE FILE to DELETE FILE FROM command Add 2X.52 add ABORT COPY FILE TO command Revised 2/25/97 Modify 3X.05 PORT STATUS command supporting detail Revised 2/24/97 Modify 2X.27 GET FROM ARCHIVE command supporting detail Modify 2X.2A SEND TO ARCHIVE command supporting detail Add 1X.0A EE MODE command Revised 2/21/97 Modify 3X.16 ID REQUEST command supporting detail Modify 3X.10 SYSTEM STATUS REQUEST supporting detail Revised 8/30/96 Added Note on Ids Reserved commands for manufacturer compatibility 0X.12, 2X.36, 2X.3B, 2X.3C, 2X.3D, 2X.3E, 2X.3F, 2x.43, 2x.44, 2X.45, 2X.C2, 3X.23 Added 2X.2E SYSTEM DELETE ID Added 2X.1D RENAME command Added 2X.43 DISK PREROLL command Added 3X.25 MULTIPLE PORT STATUS request Modify 2X.23 RECORD INIT command supporting detail Added 2X.50, 2X.51 MOVE FILE, DELETE FILE commands Revised 2/22/96 Added 3X.25 MULTIPLE PORT STATUS request Added 2X.1D RENAME command Added 2X.43 DISK PREROLL command Revised 2/22/95 Added 3X.15 LIST ID’S ADDED TO ARCHIVE request Added ID’s Added to archive bit in Status 2 of Port Status 3X.05 V DCP P ro t oc o l 0 B C HA N GE T AB L E © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 7 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Added System Rebooted bit in Status 3C of Port Status 3X.05 Added Port Idle Error Bit in Status 3C of Port Status 3X.05 Added Port Not Playing Error Bit in Status 3C of Port Status 3X.05 Added ID Not Transferred Error Bit in Status 3B of Port Status 3X.05 Added ID Transferred Error Bit in Status 3B of Port Status 3X.05 Added more description of Error bits and causes in Port Status 3X.05 Changed requirements in RECORD INIT command Changed requirements in LIST ID’S ADDED, LIST ID’S DELETED Added optional and required command keys in the command table Added new fields and bit definitions to SYSTEM STATUS REQUEST Added SELECT LOGICAL DRIVE command 2X.2D Added RECORD INIT WITH DATA command 2X.2C Defined data in COMPRESSION SETTINGS REQUEST 3X.17 Added requirements to SORT command 2X.20 Added requirements to ACK and NAK Added requirements to Local Enable 0X.0D Added Remote Control Disable bit in SYSTEM STATUS 3X.10 Revised 12/01/94 Merged buffer commands into main body Change 2X.27 Get from Main to Get From Archive Delete 2X.28 Delete from Buffer Change 2X.29 Buffer Clear to Clear Change 2X.2A Send to Main to Send to Archive Delete 3X.20 Buffer Status Req.; Use System Status Request Delete 3X.22 Buffer ID Info; Use ID Request Change 3X.16 ID Request Bit Map Response Revised 11/15/94 Add 0X.15 Protect ID Add 0X.16 Unprotect ID Add 0X.14 Delete from Archive Add 2X.1E Preset Standard Time Add 2X.1F New Copy Add 2X.2B % To Signal Full Change H. Phase Adjust to H. Pos. Adjust Change Device Type request from 0X.11 to 3X.08 Add command type 4 Deferred commands V DCP P ro t oc o l 0 B C HA N GE T AB L E © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 8 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Add Standard Time to system status Change cue/init definition Add Appendix Hardware Buffer Protocol Revised 8/8/94 2X.23 Change RECORD CUE to RECORD INIT 2X.24 Correct the number of data bytes 2X.25 Change PLAY CUE WITH DATA to CUE WITH DATA 3X.10 Correct typo BLACK TO BLOCK. Note: The largest contiguous block is the largest recordable block and in most cases is the same as TOTAL TIME REMAINING. Revised 6/27/94 Change 3X.11 BC=2 Change 3X.18 BC=2 Change 3X.19 BC=2 3X.05 Moved ID’s added and deleted to port status Removed GPI enable from port status 3X.06 Replaced bit map with command byte 3X.18 Added ‘in subsequent transmissions’ 3X.11 Removed sort byte 3X.18 Removed sort byte 3X.19 Removed sort byte Added SORT MODE command 2X.20 Revised 5/13/94 Change 1X.07 BC=3 Change 1X.08 BC=5 Delete 2X.20 Change 2X.23 Name=Record Init Change 2X.24 Name=Cue Change 2X.25 Name=Cue with Data Change 2X.31 BC=6 Change 2X.34 Name=Audio In Level Delete 2X.35 Added 2X.35 Audio Out Level command Change 2X.3A BC=4, Name=Record Mode Change 3X.06 BC (returned)=7 V DCP P ro t oc o l 0 B C HA N GE T AB L E © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 9 o f 5 9 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Change 3X.18 BC=3 Change 3X.19 BC=3 Change requirements of 0X.11 Change requirements of 1X.00 Change requirements of 3X.05 Added 3X.01 OPEN PORT command Revised 2/1/94 Add CUE WITH DATA command 2X.25 Added RECORD MODE command 2X.3A Change requirements of 2X.24 Play Cue Change requirements of 2X.25 Play Cue with Data Added PRESET command 2X.3A V DCP P ro t oc o l 1 B V I D E O DI S K CO M M U NI CA TI O N S P R O TO CO L © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 10 o f 59 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 VIDEO DISK COMMUNICATIONS PROTOCOL General The video disk communications protocol will use a tightly coupled master-slave methodology. The controlling device will take the initiative in communications between the controlling device (automation) and the controlled device. The topology will be point to point. The video disk protocol conforms to the OSI (open system interconnection) reference model. Layer 1, is the physical layer which consists of the electrical and mechanical specifications. Layer 2, the data link level covers the synchronization and error control for the information transmitted over the physical link. Layers 3 and 4 provide network functionality and are not applicable. Layer 5, the session layer, provides the control structure for communications between applications: establishes, manages, and terminates connections (sessions) between cooperating applications. Level 6, the presentation layer, contains the control language (dialect). The command tables and command description provides this functionality. A time line command set has been included for systems that must use the protocol over a non-deterministic network environment. Electrical and Mechanical Specifications1 Communications Signal Asynchronous bit serial, word serial Conforms to EIA RS-422A Full duplex communications channel Transfer rate: 38.4 kb/s Bit Configuration 1 start bit (space) 8 data bits 1 parity bit (odd) 1 stop bit (mark) V DCP P ro t oc o l 1 B V I D E O DI S K CO M M U NI CA TI O N S P R O TO CO L © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 11 o f 59 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 Byte time = .286 msec. Connection (9 Pin D-subminiature) PIN CONTROLLING DEVICE ONTROLLED DEVICE 1 Frame Ground Frame Ground 2 Receive A Transmit A 3 Transmit B Receive B 4 Transmit Common Receive Common 5 Spare Spare 6 Receive Common Transmit Common 7 Receive B Transmit B 8 Transmit A Receive A 9 Frame Ground Frame Ground A and B are defined as below. B A R A < B ---- "1 " (M A R K ) A > B ---- "0 " (S P A C E ) T Note 1: Although a bit serial mechanism is suggested other data transport systems may be implemented providing levels 5 and 6 are not violated. Session Specification Data communications between the CONTROLLING DEVICE and the CONTROLLED DEVICE is performed in accordance with the following format. The command message is comprised of a sequence between 2 and 256 bytes. STX BC TYPE/UA CMD-2 DATA-1 DATA-2 DATA-N CHECKSUM CMD-1 STX : Start of Text Code (02h) Byte 1. Byte Count (BC): Indicates the number of bytes between the byte count and the checksum. Byte 2. Command 1 : Command 1 consists of a command type nibble and unit address nibble. Command Type (4 bits) V DCP P ro t oc o l 1 B V I D E O DI S K CO M M U NI CA TI O N S P R O TO CO L © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 12 o f 59 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 0 :SYSTEM COMMAND 1 :IMMEDIATE COMMAND 2 :PRESET/SELECT COMMAND 3 :SENSE REQUEST 4 :DEFERRED (TIMELINE) COMMAND 5 :MACRO COMMAND 6 :NOT DEFINED 7 :NOT DEFINED 8 :VARIABLE ID LENGTH SYSTEM COMMAND 9 :VARIABLE ID LENGTH IMMEDIATE COMMAND (none defined currently) A :VARIABLE ID LENGTH PRESET/SELECT COMMAND B :VARIABLE ID LENGTH SENSE REQUEST C :NOT DEFINED D :VARIABLE ID LENGTH MACRO COMMAND E :NOT DEFINED F :ARCHIVE COMMAND (separate protocol) Unit Address (4 bits) Defines the address of a sub-system within the device. The base unit is 0. Byte 3. Command 2 : This byte is the command code, it identifies the syntax of the data which follows (if any). A bit map may be added to some command blocks. In the bit map, data corresponding to the designated bit is accessed. The data corresponding to bit map data 1 is added after the map. Data is added sequentially from the low order bit of the map data (figure 3). The response to command types 0, 1, and 2 is ACK (04h) or NAK (05h). The response to command type 3 will set the most significant bit of the command to a 1, e.g. the response to command 29 is A9. The command codes form a unique device dialect. Checksum: The 2's complement of the least significant byte of the sum of all command and data bytes from the first command byte to immediately before the checksum. Examples of command types 1, 2, and 3 are shown below in figures 1, 2, and 3 respectively. Immediate Command Command Code: 01 Name: Play Function: Causes the controlled device to enter field lock real time playback state. Data Format: 01 CMD-2 Data Configuration: V DCP P ro t oc o l 1 B V I D E O DI S K CO M M U NI CA TI O N S P R O TO CO L © 2 00 3 - 2 00 9 Ha r r i s Co r po ra t i o n Ha r r i s P r op r i e ta r y I n fo r ma t i on P a ge 13 o f 59 Re l eas e : 2 4 - Fe b ru a r y - 2 00 3 02 02 10 01 EF STX BC CMD-1 CMD-2 CS Return: ACK (04h) NAK (05h) FIGURE 1 Preset/Select Command Command Code: 39 Name: Select Input Function: Selects the input format Data Format: 39 * CMD-2 MODE * Mode Byte: 01h Off (Black w sync) 02h Composite 04h S-Video 08h YUV 10h D1 Data Configuration: 02 03 2X 39 * STX BC CMD- 1 CMD- 2 MODE CS Return: ACK (04) NAK (05) FIGURE 2 Sense Request Command Code: 05 Name: Port Status Request Function: Requests the port status. The requested data can be designated using a bit map. Data Format: 05 * CMD-2 BIT MAP PSTAT PSTAT PSTAT PSTAT PSTAT PSTAT PSTAT PSTAT V DCP P ro t oc o l 1 B V I D E O