User manual UNIBRAIN UBCORE 3.1

ubCoreTM 3.1 User Guide unibrain The 1394 Innovators e-mail: support@unibrain.com web: http://www.unibrain.com store: http://www.1394store.com/ 1 ubCoreTM 3.1 User Guide November 2003 Unibrain introduces to the IEEE-1394 users and developers community, the latest ubCoreTM version 3.1, the first and only FireWire (IEEE-1394) driver suite that fully supports the 1394b standard. ubCoreTM is a set of low-level drivers with a top-down layered structure that provides the physical interface to various 1394 devices and includes the following advantageous features: · · · · · Full 1394b support at 800Mbps. Complete 1394a and 1394b SBP2 disk support for Windows 98SE/Me/2000/XP. Comprehensive set of tools and applications. Seamless integration to all Windows OS. User friendly installation wizard. ubCoreTM combined with FireAPITM (Unibrain's 1394 Development Toolkit), provides to the software developer a powerful set of functions and tools that enables him to integrate 1394 technology into his product. Unibrain has built a number of 1394 applications based on FireAPITM and included in ubCoreTM: · · · · · FireViewerTM: a 1394 Bus Viewer utility that displays the current topology of the local 1394 bus. FireCommanderTM a 1394 command interpreter tool that is used to pass commands to the 1394 stack. Benchmarking support is included. FireNetTM: Software to network two or more computers via 1394a or 1394b. Fire-iTM: Software to Control and Display any 1394 Digital Camera (IIDC). Fire-ShareTM: Software to allow sharing of any 1394a or 1394b SBP2 disk among multiple users. (Demo version) Software Compatibility of ubCoreTM · Windows NT4/98SE/Me/2000/XP Hardware Compatibility of ubCoreTM · Unibrain's or any third party 1394a or 1394b OHCI PCI/PCMCIA compliant adapter · Any Desktop/Portable PC with built-in 1394a or 1394b OHCI support. · Unibrain's FireBoard400TM (PCI Lynx 2) 1394a PCI adapter. Free Evaluation of ubCoreTM The ubCoreTM software you are about to install is the complete and fully functioning version for all the Windows environments. Upon initial installation, usage is restricted to an evaluation period of 30 minutes, at the end of which the driver stack will automatically turn off (without affecting the rest of your computer operations in any way). You can repeat the demo as many times as you wish by simply rebooting your PC. Product Keys To enable unrestricted use or "authorized" use of ubCoreTM software, a Product Key is required for each and every computer that has installed ubCoreTM. Product keys may be purchased online at: http://www.1394store.com/ 2 ubCoreTM 3.1 User Guide Table of Contents TABLE OF CONTENTS........................................................................................................... 3 TECHNICAL SUPPORT INFORMATION................................................................................ 5 FEATURES OF UBCORE 3.1 ................................................................................................. 6 UBCORETM VERSUS MICROSOFT 1394 STACK ............................................................................. 8 SETUP CHECKLIST.............................................................................................................. 10 UBCORETM INSTALLATION................................................................................................. 11 INTRODUCTION......................................................................................................................... 11 UBCORETM INSTALLATION PROCEDURE..................................................................................... 12 VERIFICATION OF UBCORETM INSTALLATION ............................................................................. 17 VERIFICATION ON WINDOWS NT4 .............................................................................................17 VERIFICATION ON WINDOWS 98SE/ME/2000/XP ......................................................................19 DIRECTORY STRUCTURE OF UBCORETM INSTALLATION.............................................................. 20 COEXISTENCE OF UBCORETM AND MICROSOFT 1394 STACK ..................................................... 23 THIRD PARTY 1394B PCI CONTROLLERS WORKING WITH UBCORETM ......................................... 27 UNINSTALLING UBCORETM ....................................................................................................... 28 UPGRADING UBCORETM ........................................................................................................... 28 UBCORETM AUTHORIZATION PROCEDURE ..................................................................... 29 FIREAPITM AUTHORIZATION PROCEDURE AND LICENSING POLICY ........................... 31 1394A AND 1394B SBP2 DISK DRIVER.............................................................................. 32 INSTALLING SBP2 DISK DRIVER IN WINDOWS 98SE/ME ............................................................ 33 1394 SBP2 EXTERNAL DISK CONNECTION ................................................................................ 35 SAFE REMOVAL OF 1394 SBP2 DISKS ..................................................................................... 40 FIREVIEWERTM-1394 BUS VIEWER .................................................................................... 41 THE NODE TREE ...................................................................................................................... 41 COLOR AND PATTERN CODING ................................................................................................. 43 ADAPTER SELECTION ............................................................................................................... 44 WINDOW APPEARANCE ............................................................................................................ 45 NODE SIZE ...............................................................................................................................45 PORTS.....................................................................................................................................45 CAPTION AND MENU BAR ..........................................................................................................45 ALWAYS ON TOP.......................................................................................................................45 NODE PROPERTIES ..................................................................................................................46 BUS ANOMALIES .......................................................................................................................47 MENU ...................................................................................................................................... 48 VIEW MENU ..............................................................................................................................48 HELP MENU..............................................................................................................................48 FIRECOMMANDERTM- 1394 COMMAND INTERPRETER................................................... 49 RUNNING THE PROGRAM .......................................................................................................... 49 COMMAND SYNTAX .................................................................................................................. 51 AVAILABLE COMMANDS............................................................................................................ 52 FIRENETTM-1394 NETWORKING ......................................................................................... 59 3 ubCoreTM 3.1 User Guide INSTALLATION ON WINDOWS NT4 ............................................................................................ 59 VERIFY INSTALLATION ..............................................................................................................61 INSTALLATION ON WINDOWS 98SE/ME/2000/XP...................................................................... 62 UN-INSTALLING FIRENETTM ...................................................................................................... 65 FIRE-ITM-1394 IIDC CAMERAS SUITE ................................................................................. 66 FIRE-ITM COMPATIBILITY .......................................................................................................... 66 FIRE-ITM APPLICATION GUIDE................................................................................................... 67 CONNECTED CAMERAS ............................................................................................................67 VIDEO FORMAT ........................................................................................................................67 VIDEO MODE............................................................................................................................67 FRAME RATE............................................................................................................................67 SPEED .....................................................................................................................................68 MEMORY PRESETS...................................................................................................................68 CAMERA CONTROL...................................................................................................................68 DISPLAY POPUP MENU .............................................................................................................69 FIRE-ITM SHORT-KEYS ............................................................................................................. 72 FIRESHARETM ....................................................................................................................... 73 IMPORTANT WARNING!............................................................................................................. 73 INTRODUCTION......................................................................................................................... 73 USING FIRESHARETM ............................................................................................................... 74 DISK COLORING .......................................................................................................................75 FIRESHARETMAUTHORIZATION ................................................................................................. 77 4 ubCoreTM 3.1 User Guide Technical Support Information All technical support questions should be directed to the following email address: support@unibrain.com This address is monitored throughout the day by Unibrain's 1394 support team, who will respond quickly and with the required technical accuracy, to your questions. Please refrain from sending any queries directly to Unibrain engineering staff, in order to maintain our support database and make sure that your email will be responded to, in case any specific person is unavailable. Please, try to be as specific as possible in your inquiries to this email address, and to restrict questions to technical issues. For pricing and marketing information, please e-mail at: sales@unibrain.com For ordering any Unibrain product please visit: http://www.unibrain.com/ http://www.1394store.com/ 5 ubCoreTM 3.1 User Guide Features of ubCore 3.1 ubCoreTM version 3.1 provides to both existing customers and to new users, the next generation of Unibrain's innovative 1394 driver suite with the following advantageous features: 1). Full 1394b support at 800Mbps speed rate. ubCoreTM 3.1 is the first and only IEEE1394 (FireWire) driver platform providing full support of the latest 1394b standard. This support includes amongst others: · · · · · · · · · · New Self-ID Packets Changes to PHY Register Set Request Higher speed packets Request bigger packets at higher speeds Pipelining of packet transmit requests Handling faster receipt of BOSS asynchronous packets Path Speed being Port dependent and not Node Dependent Adapt to longer length cables and larger variations in PHY repeater delays Picking the most optimal packet format Initiating and resuming from the "Standby" power mode 2). Full 1394b support at S100 (CAT5) and S200 (POF) speed rates. ubCoreTM 3.1 is the first and only IEEE-1394 (FireWire) driver platform providing full support of S100 speed rate using CAT5 cable as the interconnection mean between two nodes. Moreover ubCoreTM fully supports the S200 speed between two nodes connected via Plastic Optical Fiber (POF). With sophisticated and recursive built in algorithms, ubCoreTM builds a correct speed map of each port of every node in the 1394b bus. This speed map determines the maximum speed that a node can be accessed. ubCoreTM can do transactions at any speed, and uses the maximum speed of a specific node that works. This automatic mechanism enables the correct communication of every node in a 1394b bus even if not all devices operate at S100 or S200 speeds. 3). Complete SBP2 support for 1394a and 1394b SBP2 hard disks. SBP-2 ("Serial Bus Protocol", 2nd version) is the best model for computer peripherals. Its use is strongly preferred, largely because it greatly reduces interrupt load on the CPU, and provides a scalable DMA model. The general architecture provides a command and data transport mechanism that exports the command processing and queuing to the peripheral, effectively making each device a powerful scriptable DMA device. This is done by mapping some area of the CPU's memory directly to 1394's memory space, building a linked-list of commands and pointers to data buffers in that area, and then giving the address of that list to the device. The device then reads the commands directly from the CPU and takes the appropriate action, including reading data from or writing data directly to CPU memory. Unibrain's 1394 SBP2 driver is fine tuned for speeds of 800Mbps providing the fastest 1394b interface to external S800 SBP2 Hard disks. It is also compatible and fully supports Removable Devices and other SBP2 compliant devices like Apple's iPod. Moreover Unibrain provides the Fire-ShareTM 1394 SBP2 application for multi-share of 1394 SBP2 hard disks. As you probably know, while it is possible for a PC to attach to many 6 ubCoreTM 3.1 User Guide external 1394 SBP2 disks, it is impossible to simultaneously attach one 1394 SBP2 disk to many PCs connected via FireWire. In other words the SBP2 drive will be attached and recognized only by one PC, in a FireWire network. With Fire-ShareTM you are now able to have mutually exclusive usage of the 1394 SBP2 disk, and once used, you can release it notifying the other PCs so this disk becomes available for other user. 4). IIDC 1394 Digital Cameras Specification 1.30 support Along with ubCoreTM 3.1, you receive the full IIDC 1394 stack to control and display 1394 digital cameras. 5). Native networking capabilities provided by FireNetTM Unibrain's FireNetTM software, one more application implemented over ubCoreTM, is THE FIRST FireWireTM Networking Solution for ALL Windows platforms. FireNetTM is a systemindependent software product that gives you full Ethernet compatibility at speeds of up to 800Mbps. The basic features of FireNetTM are: · · · · · Complete Ethernet emulation. Supports various network protocols: TCP/IP, NetBEUI, IPX/SPX, etc. High speed ­ up to 8 times the performance of 100Mbps fast Ethernet. No hubs, no routers, complicated cabling, or complex installations. Fast and Easy installation. 6). Support on ALL Microsoft operating systems: NT4/98SE/Me/2000/XP. Unibrain's ubCoreTM is the only existing 1394b software platform for the Windows environments. 7). Complete hardware support. ubCoreTM 3.1 supports Unibrain's or any third party 1394a or 1394b OHCI PCI/PCMCIA compliant adapter or any Desktop/Portable PC with built-in 1394a or 1394b OHCI support. Also supports Unibrain's FireBoard400TM (PCI Lynx 2) 1394a PCI adapter. 7 ubCoreTM 3.1 User Guide ubCoreTM versus Microsoft 1394 stack As is already mentioned, ubCoreTM is a complete driver stack providing support for all 1394a and 1394b devices. With your Microsoft operating system you get also a 1394a driver stack built in, for the support of all the 1394a devices. The following comparison table presents the basic ubCoreTM features and advantages in contrast with the features of the Microsoft 1394 stack. Features 1394a Software support 1394b Software support 1394a Hardware support Microsoft 1394 stack NO Windows NT4 NO OHCI only ubCoreTM 3.x /FireAPITM 3.x Windows NT4, 98SE, Me, 2000, XP Windows NT4, 98SE, Me, 2000, XP Lynx2 and OHCI compatible boards FireBoard800TM and any other 1394b compliant device based on the Texas Instruments TSB82AA2 1394b to PCI controller. 1394b Hardware support NO IIDC 1394 cameras 1394 SBP2 Hard Disk support 1394 Native Networking Primitive support on Fire-iTM application and IIDC drivers for Windows 98Se, Me, 2000, Windows NT4, 98SE, Me, 2000, XP. XP (FireAPITM includes FULL source code) No sharing application Primitive support on Windows Me, XP FireShareTM application FireNetTM drivers for Windows NT4, 98SE, Me, 2000, XP FireViewerTM application, a 1394 Bus Viewer utility that displays the current topology of the local 1394 bus. (FireAPITM includes FULL source code) FireCommanderTM application, a 1394 command interpreter tool that is used to pass commands to the 1394 stack. (FireAPITM includes FULL source code) SBMTM driver, providing the set of functions to control bus management and isochronous resource management. (FireAPITM includes FULL source code) 1394 Topology Tool NO 1394 Control Tool NO Serial Bus Manager NO 8 ubCoreTM 3.1 User Guide Virtual 1394 Device support User mode API for applications development Loopback functionality. Source samples (for FireAPITM) Support Primitive support on Windows Me, XP NO NO 2 NO Windows NT4, 98SE, Me, 2000, XP YES (FireAPITM) YES 44 YES Table 1: ubCoreTM versus MS 1394 stack 9 ubCoreTM 3.1 User Guide Setup Checklist Before proceeding with the product installation, please verify that: Check No. 1 2 Description Your host PC operating system is Windows NT4/98SE/Me/2000/XP. For all operating systems (but especially for Windows 98SE and Windows Me), please be sure to have latest updates installed! Your PC has a FireWire (i-Link) IEEE-1394 interface based on: · Unibrain's or any third party 1394a or 1394b OHCI PCI/PCMCIA compliant adapter or · any built-in 1394a or 1394b OHCI support or · Unibrain's FireBoard400TM (PCI Lynx 2) 1394a PCI adapter. You have disabled the Plug and Play Operating System flag on your BIOS setup, in case that you are going to install ubCoreTM into Windows NT 4.0 system. Please also verify that your system has installed Service Pack 6! IMPORTANT! Always UNPLUG the connecting FireWire cables between all the FireWire computers and devices before you begin installing or uninstalling ubCoreTM software. IMPORTANT! ALWAYS COMPLETELY UNINSTALL ANY PREVIOUS VERSION OF ubCoreTM BEFORE INSTALLING THE NEW ONE. Please refer to section "Upgrading ubCoreTM" Check? () 3 4 5 6 Table 2: Setup Checklist 10 ubCoreTM 3.1 User Guide ubCoreTM Installation Introduction For all operating systems there are common basic tasks during installation that you should follow. Those tasks are in essence the next: Task No. 1 2 3 Description Verify the Setup Check list described in the previous Table 2 Follow the installation instructions described into the next paragraphs. IMPORTANT! IN CASE YOU ARE ABOUT TO INSTALL ubCoreTM TO A SYSTEM ALREADY HAVING ubCoreTM, THEN THE CORRECT PROCEDURE IS TO COMPLETELY UN-INSTALL THE OLD VERSION, REBOOT YOUR SYSTEM AND THEN FOLLOW THE STEPS OF THE INSTALLATION PROCEDURE IN ORDER TO IN STALL THE NEW VERSION. Once finished your installation (you need to restart your system) you have to check the correct installation of ubCoreTM. There are many procedures to do, but the most simple and straightforward is the usage of the FireViewerTM application. Please refer to the section "Verification of ubCoreTM installation" After verifying the correct installation of ubCoreTM it is time to fully authorize it. Please recall from previous section that the ubCoreTM software you already have installed is a complete and fully functioning version that its usage is restricted to an evaluation period of 30 minutes, at the end of which the driver stack will automatically turn off (without affecting the rest of your computer operations in any way). You can repeat the demo as many times as you wish by simply rebooting your PC. To enable unrestricted use or "authorized" use of ubCoreTM software, a Product Key is required for each and every computer that has installed ubCoreTM. Product keys may be purchased online at the 1394store.com or from any distributor. Please refer to the section "Authorization procedure" for more details. Check? () 4 5 Table 3: Basic Installation Tasks 11 ubCoreTM 3.1 User Guide ubCoreTM installation procedure This part explains how to install ubCoreTM 3.1 in your system under the Windows XP operating system. Windows NT4/98Se/Me/2000 have a similar installation. Please notice that the ubCoreTM installer automatically identifies the target Operating System and installs the required files accordingly. The first step is to verify that the Microsoft 1394 stack is installed in your system. Provided that you have the required 1394 hardware in your PC, the Windows XP system will recognize it as an IEEE 1394 Bus host Controller and will install it automatically as can be seen from the Device Manager (see next figure). Locate the file "ubCore3.exe" and launch it by double-clicking on it. The Welcome screen will be displayed. To continue with the installation, click on "Next". 12 ubCoreTM 3.1 User Guide The ubCoreTM License Agreement is being displayed next. Read this Agreement thoroughly. If you agree with the terms stated in this License Agreement, click on "Yes". Enter your Customer Information, click Next and Choose the Destination Location of the ubCoreTM files. Choose the type of installation. The default selection is "Typical", but in case you want to modify the configuration, choose the option "Custom". 13 ubCoreTM 3.1 User Guide In this case that you choose custom installation, verify the settings as shown in this dialogue. Mark the features and options that you want to be installed in your system: ubCore: 1394a and 1394b low-level drivers that provides the interface to various 1394 devices. 1394a and 1394b SBP2 disk support is included. FireViewer: A 1394 Bus Viewer utility that displays the current topology of the local 1394 bus. FireCommander: a 1394 command interpreter tool that is used to pass commands to the 1394 stack. Benchmarking support is included. FireNet: 1394 Networking software. FireShare: Software to allow sharing of any 1394a or 1394b SPB2 disk among multiple users (Demo Version). Fire-i: Software to Control and Display any 1394 IIDC camera. ubCore Authorize utility: Utility to authorize ubCore software for unlimited use. A Product Key "PK" number is needed. 14 ubCoreTM 3.1 User Guide If all options are set correctly, click on "Next" to complete the installation process. You can let Install create a new Program Folder or add the Unibrain ubCoreTM icons to any existing group. In the latter case, select the Group you want to add ubCoreTM. Press Next to proceed. The installer will start copying the required files in the respective directories. Once the next dialogue box appears, press "Continue Anyway" 15 ubCoreTM 3.1 User Guide Once the installation procedure is completed you will see the final dialogue from the installer. Press finish to proceed. The ubCoreTM driver stack and the accompanying software is installed and if you monitor the device manager you can observe the presence of Unibrain's driver for the control of the "IEEE 1394 Bus host controllers" To verify that the ubCoreTM suite of drivers are all installed successfully run the FireViewerTM utility from the "Start­>Programs­>ubCore". For more details please refer to the section "Verification of ubCoreTM installation". 16 ubCoreTM 3.1 User Guide Verification of ubCoreTM Installation Verification on Windows NT4 The most simple procedure to verify the correct installation of ubCoreTM is to run the FireViewerTM utility from the "Start­>Programs­>ubCore". Provided that you have one 1394 PCI controller, not connected with any other FireWire device, you should see the following window: For more details on the FireViewerTM application, please refer to the respective section. There is also an alternative way to verify that the ubCoreTM suite has been correctly installed at your Windows NT 4 system. After reboot open the Control Panel/Devices and go to the entry "UB" In case you have installed a FireBoard400 or a FireCompact400 four Unibrain Drivers should have started Automatically: · · · · Unibrain 1394 PCILynx Driver ­ UBLynx.sys PCILynx-2 minport for FireBoardTM400 or FireCompact400 Unibrain 1394 Class Driver ­ UB1394.sys Kernel Mode (ring 0) 1394 API Unibrain 1394 FireAPI Driver ­ UBUMAPI.sys User Mode (ring 3) 1394 API Unibrain 1394 SBM Driver ­ UBSBM.sys Serial Bus Manager client driver 17 ubCoreTM 3.1 User Guide In case you have installed a Unibrain's FireBoard800TM or a FireBoard400-BlueTM or a FireCardTM or any other third party OHCI compliant 1394 board, then you should have: · · · · Unibrain 1394 OHCI Driver ­ UBohci.sys OHCI miniport for OHCI compliant 1394 PCI controllers Unibrain 1394 Class Driver ­ UB1394.sys Kernel Mode (ring 0) 1394 API Unibrain 1394 FireAPI Driver ­ UBUMAPI.sys User Mode (ring 3) 1394 API Unibrain 1394 SBM Driver ­ UBSBM.sys Serial Bus Manager client driver 18 ubCoreTM 3.1 User Guide Verification on Windows 98SE/Me/2000/XP The most simple procedure to verify the correct installation of ubCoreTM is to run the FireViewerTM utility from the "Start­>Programs­>ubCore". Provided that you have one 1394 PCI controller, not connected with any other FireWire device, you should se the following windows: For more details on the FireViewerTM application, please refer to the respective section. There is also an alternative way to verify that the ubCoreTM suite has been correctly installed at your Windows 98SE/Me/2000/XP system: At the Device Manager you should be able to see the driver installed under the "IEEE 1394 Bus host controllers" section. For example, in the next figure you can see the "Unibrain driver/FireBoard-Blue" and the "Unibrain driver/FireBoard800" entries, providing you with the information that the two 1394 PCI adaptors in your system (one FireBoard-Blue and one FireBoard800) have been correctly recognized by ubCoreTM. 19 ubCoreTM 3.1 User Guide Directory structure of ubCoreTM installation After the complete installation of ubCoreTM 3.1 the directory structure should be as depicted in the next figure, provided that you use the default destination directory: "E:\Program Files\Unibrain". 20 ubCoreTM 3.1 User Guide So the ubCoreTM subdirectory is structured as follows: · \ubCore\: here are provided the following 3 applications: FireCommander: a 1394 command interpreter tool that is used to pass commands to the 1394 stack. Benchmarking support is included. FireViewer: A 1394 Bus Viewer utility that displays the current topology of the local 1394 bus. ubCore Authorize: Utility to authorize ubCoreTM software for unlimited use. · \ubCore\drivers: here are provided the ub1394.inf and ubsbp2.inf system information files. · \ubCore\drivers\WinNT: (for NT4/2000/XP OSs) or · \ubCore\drivers\Win98: (for 98SE/Me OSs) here are provided the drivers operating for all the OSs: UB1394.sys: Unibrain 1394 Class Driver ­ Kernel Mode 1394 API UBLynx.sys: Unibrain 1394 PCILynx Driver PCILynx-2 minport for FireBoard400TM or FireCompact400TM UBOHCI.sys: Unibrain 1394 OHCI Driver OHCI miniport for OHCI compliant 1394 PCI controllers UBSBM.sys: Unibrain 1394 SBM Driver ­ Serial Bus Manager client driver UBUMAPI.sys: Unibrain 1394 FireAPI Driver ­ User Mode 1394 API 21 ubCoreTM 3.1 User Guide · \ubCore\Fire-i: here is provided the FireiTM application software to Control and Display any 1394 IIDC camera, along with the required Firei.dll and *.ubd description files for all the SONY 1394 IIDC cameras. · \ubCore\FireNet: here is provided the FireNetTM (1394 Networking software) driver and this is the path you should retrieve during the manual installation of FireNetTM. (Please refer to the FireNetTM Installation section for more details) · \ubCore\FireShare: here is provided the FireShareTM, demo Software to allow sharing of any 1394a or 1394b SPB2 disk among multiple users. Moreover the authorization program is located in this folder. Please refer to the FireShareTM chapter for further details. 22 ubCoreTM 3.1 User Guide Coexistence of ubCoreTM and Microsoft 1394 stack As a user of Microsoft Operating Systems, you should know that for many devices you can find various driver providers including the device manufacturer and of course Microsoft. The same also applies for ubCoreTM in that it can be used as an alternative to the built in 1394 drivers of Microsoft. Please note that because ubCoreTM is a Plug and Play stack, it can be dynamically interchanged with the Microsoft drivers. The following paragraphs present this procedure for a Windows XP system. Lets assume that your system has two 1394 PCI devices; one FireBoard800TM (Unibrain's 1394b, 64 bit PCI adaptor) and one FireBoard-BlueTM (Unibrain's 1394a, 32 bit PCI adaptor) and that you have successfully installed ubCoreTM in your system. So if you see the Device Manager you should observe a system configuration like the one bellow: In order to change the driver for FireBoard-BlueTM from Unibrain's ubCoreTM to Microsoft 1394 stack drivers, select the "Unibrain driver/ FireBoard-BlueTM", right click your mouse button and from the properties select "Update Driver...". The Hardware Update Wizard will appear, as seen in the next picture: 23 ubCoreTM 3.1 User Guide Select the "Install from a list of specific location (Advanced)" radio button and click Next In the next dialogue, select the "Don't search, I will choose the driver to install" option 24 ubCoreTM 3.1 User Guide Select the appropriate driver (in our case is "Texas Instruments OHCI Compliant IEEE 1394 Host Controller") and click Next This is the completion stage of your hardware update, so please click Finish in the next dialogue. 25 ubCoreTM 3.1 User Guide Following the above procedure you have replaced the ubCoreTM 1394 driver with the Microsoft 1394 stack and the Device Manager should appear like the below picture. Please notice that for FireBoard800TM we kept the same driver based on Unibrain's ubCoreTM because it is the only existing driver providing full 1394b capabilities! Please also recall that with a similar to the above procedure you can switch from Microsoft 1394 stack, back to ubCoreTM. 26 ubCoreTM 3.1 User Guide Third party 1394b PCI controllers working with ubCoreTM As is already mentioned, ubCoreTM 3.1 supports Unibrain's or any third party 1394a or 1394b OHCI PCI/PCMCIA compliant adapter or any Desktop/Portable PC with builtin 1394a or 1394b OHCI support. The two adjacent figures display how the ubCoreTM 1394 stack recognizes and represents in the Device Manager two 1394b PCI controllers: the FWB-PCI01 board from IOI Technology Corporation and the GIC3800 from IOGEAR. 27 ubCoreTM 3.1 User Guide Uninstalling ubCoreTM The procedure to uninstall ubCoreTM is straightforward. Just select from "StartProgram FilesubCoreUnistall ubCore" The following Dialogue box will appear. Select the Remove option and press "Next". Upgrading ubCoreTM The correct procedure to upgrade your ubCoreTM is to completely uninstall the old version, REBOOT your system and then follow the steps of the installation procedure in order to install the new version. 28 ubCoreTM 3.1 User Guide ubCoreTM Authorization procedure To enable an unrestricted use of the ubCoreTM software, a unique "Name" and "Product Key" combination per PC station is required. You can purchase Product Keys online at: http://www.1394store.com/, in order to enable ubCoreTM to run continuously. After obtaining a Product Key for each computer, run the "ubCore Authorize utility" application, which can be found in Start Menu ! Program Files ! ubCore ! ubCore Authorize. Enter your Name and the Product Key in the appropriate fields and press OK. The application will display a message indicating if the operation was successful or not. In order to enable unlimited usage of the ubCoreTM stack and all the accompanying applications (FireViewerTM, FireCommanderTM, Fire-iTM) BUT NOT FireShareTM, you have to provide to the ubCoreTM Authorize Utility a product key starting with the key word CORE, as in the next figure. 29 ubCoreTM 3.1 User Guide In order to enable unlimited usage of the ubCoreTM stack and all the accompanying applications (FireViewerTM, FireCommanderTM, Fire-iTM) INCLUDING FireShareTM, you have to provide to the ubCoreTM Authorize Utility a product key starting with the key word SHRE, as in the next figure. If you have installed in your system a Unibrain board with the "ubCore 3.x Compliant" label, then you are authorized for unlimited usage of ubCoreTM and you do not need to enter Authorization Product Key. If you do so, the next message will appear. 30 ubCoreTM 3.1 User Guide FireAPITM Authorization procedure and Licensing policy As is already mentioned ubCoreTM combined with FireAPITM (Unibrain's 1394 Development Toolkit), provides to the software developer a powerful set of functions and tools that enables him to integrate 1394 technology into his product. All the applications distributed with ubCoreTM have been built based on FireAPITM: · · · · · FireViewerTM: the 1394 Bus Viewer utility that displays the current topology of the local 1394 bus. FireCommanderTM the 1394 command interpreter tool that is used to pass commands to the 1394 stack. Benchmarking support is included. FireNetTM: Software to network two or more computers via 1394a or 1394b. Fire-iTM: Software to Control and Display any 1394 Digital Camera (IIDC). Fire-ShareTM: Software to allow sharing of any 1394a or 1394b SBP2 disk among multiple users. To enable an unrestricted use of the FireAPITM, it is required the FireAPITM license per PC station. This license has two alternative forms: 1). either with the installation in your PC of one 1394 PCI board from Unibrain having the "ubCore 3.x Compliant" label, 2). or with one FireAPITM product key. This product key is a unique "Name" and "Product Key" combination required per each PC station. In order to activate your FireAPITM product key run the "ubCore Authorize utility" application, which can be found in Start Menu ! Program Files ! ubCore ! ubCore Authorize. Enter your Name and the Product Key in the appropriate fields and press OK. The application will display a message indicating if the operation was successful or not. PLEASE NOTICE THAT THE FireAPITM PRODUCT KEY STARTS WITH THE WORD FAPI. Please contact info@unibrain.com if you want to purchase "FAPI" Product Keys. 31 ubCoreTM 3.1 User Guide 1394a and 1394b SBP2 disk driver Unibrain's 1394 SBP2 driver is fine tuned for speeds of 800Mbps providing the fastest 1394b interface to external S800 SBP2 Hard disks. It is also compatible and fully supports removable Devices and other SBP2 compliant devices like Apple's iPod. The current paragraph presents the functionality of the 1394a and 1394b SBP2 disk driver installed with ubCoreTM. Please notice that this SBP2 driver is by default installed and ready to operate after the ubCoreTM installation in Windows 2000 and Windows XP. IN CASE THAT YOU HAVE Windows 98SE or Windows Me, YOU HAVE TO MANUALLY INSTALL THE SBP2 DISK AS DESCRIBED IN THE NEXT SECTION ENTITLED "Installing SBP2 disk driver in Windows 98SE/Me" After the correct installation of ubCoreTM, you can observe the SBP2 driver from the Device Manager under the System devices, enabling the option "Show Hidden Devices". Please see in this figure the "Unibrain SBP2 Bus Driver" under the System devices. It is important to emphasize that this driver is installed and displayed even if you have not plugged the external hard disk! IMPORTANT NOTE: It is highly recommended after the external HD connection to perform a system reboot. 32 ubCoreTM 3.1 User Guide Installing SBP2 disk driver in Windows 98SE/Me The following paragraphs describe the steps in order to install the ubCoreTM SBP2 disk driver in Windows 98SE/Me. Please notice that for Windows 2K/XP the installation is performed automatically, once installed ubCoreTM. · Start the Add/Remove Hardware Wizard from StartControl Panel · In the adjacent dialogue box, select "No, I want to select the hardware from a list" click Next · Select from the Hardware types list the "System devices" and click Next 33 ubCoreTM 3.1 User Guide · In the next dialogue click "Have Disk" and locate the directory in which ubCoreTM and the SBP2 driver has been placed · Once locating the driver, the next dialogue will appear. Click Next and the installation will be completed. 34 ubCoreTM 3.1 User Guide 1394 SBP2 external disk connection Lets assume that you have a FireBoard800TM in your system and you connect two (2) powered­on external 1394b Hard Disks. You can use the FireViewerTM utility to observe (see adjacent picture) the topology with FireBoard800TM in node 2 and the two external hard disks in nodes 0 and 1 respectively; notice that the default color for a 1394b node is blue A few seconds after the connection of the two external hard disks, you can see from the Device Manager under the "Disk drives" section, that both disks have been recognized by the operating system and are ready to use. 35 ubCoreTM 3.1 User Guide In case that both disk are FORMATED in a valid Windows file system format (e.g. NTFS) then you are able to explore and fully control the hard disks as valid volumes. In our example depicted in the adjacent picture, the two external hard disks have the volumes: · EXTA mapped in volume F: and · EXTB mapped in volume I:. 36 ubCoreTM 3.1 User Guide In case that your external hard disks are not FORMATED please follow the next set of instructions that apply for both Windows 2000 and Windows XP (our sample screen captures are taken from a Windows XP system): 1). Go to StartAdministrative ToolsComputer Management and double click the Disk Management option. If the SBP2 drive is plugged for the very first time, the "Initialize and Convert Disk Wizard" will appear. Click Next to continue. The number of disks that will appear depends on how many you have connected to your system. Check mark () the disks to initialize and click Next. In the next dialogue click Finish to complete the disk initialization part 2). In the next Computer Management windows that will appear, you can see a list of the available disk drives. In our case there is Disk 0 with 3 different partitions, Disk 1, Disk 2 the external Unallocated 1394 SBP2 hard disk just plugged and the CD-ROM 0 Right click on the Disk 1 that is unallocated and select the New Partition so that the New Partition Wizard will appear. 37 ubCoreTM 3.1 User Guide Select the partition type and click Next. The default type is Primary partition and is the recommended type that you select. Use Extended partition if there is a need to create more than four (4) partitions on a single drive At the "Specify Partition Size" window type in Mbytes the number of the partition size and click Next. By default, Windows XP will select the total disk space available for your drive (single partition). If you choose to create multiple partitions, change the "Partition size in MB" and click Next. At the next "Assign Drive Letter or Path" dialogue window, assign the drive letter and click Next. By default, Windows XP will select the next available drive letter. Although, you can change the drive letter, it is recommended to leave the default setting. 38 ubCoreTM 3.1 User Guide In the next dialogue select the file system for the specific hard disk. Under "Format this partition with the following settings", select FAT, FAT32 or NTFS as the File System. For "Allocation unit size" leave the default setting and give your drive a "Volume label". Once completed, click Next. At the last dialogue "Completing the Create Partition Wizard", click Finish and start working with your external hard disk. Please repeat the above procedure for each of the external 1394 SBP2 drives you attach to your system for the first time. 39 ubCoreTM 3.1 User Guide Safe Removal of 1394 SBP2 disks In order to safely remove you external 1394 SBP2 hard disk(s) please follow the same procedures as for any Plug n Play external device. More specifically: Double click on the taskbar icon to "Unplug or Eject hardware". The adjacent dialogue box will appear displaying the PnP external devices. In the current example you can see an USB Mass Storage Device and the two (2) external 1394b hard disks recognized by Unibrain's SBP2 driver. In order to remove a hard disk, click the device in the list and then click Stop. The operating system will automatically unplug the device and inform you for this safe removal. If you are using the specific hard disk (e.g. you have open a Word document located in this disk) the operating system will notify you that is unable to remove the device. In this case, close all the applications affecting the hard disk and try again. 40 ubCoreTM 3.1 User Guide FireViewerTM-1394 Bus Viewer Unibrain's 1394 Bus Viewer utility (FireViewerTM) shows the current topology of the local 1394 bus, allowing the user to continuously monitor the bus for changes in the topology and also to retrieve various information for each node. The sections below describe the usage of the FireViewerTM and the information provided by it. The Node Tree The bus is displayed as a hierarchical tree in the main application window, with the root node at the top, and the children of each node appearing on the `row' below the `row' where the parent is drawn. Inside each node, the program displays the node's physical ID and the node's speed or an icon that represents the type of the node. In the picture below, a sample bus topology is illustrated. The root node is node 10 equipped with 1394 controller providing speed up to 400Mbps (S400). Node 10 is connected to nodes 2,8 and 9, which are its children. Nodes 4 and 7 are the children of node 8, etc. Node 9 is a 1394b node with speed up to S800. 41 ubCoreTM 3.1 User Guide If a node is a PC with FireNetTM, an IIDC 1394 camera, a Camcorder with 1394 interface, or external SBP2 1394 hard disk, descriptive icons are shown instead of the speed code. The icons are: Icon Meaning The node is a PC running FireNetTM. Moving the cursor over the node will display a ToolTip window containing the computer's UNC name. The node is an IIDC 1394 digital camera The node is a Camcorder with 1394 interface The node is an external SBP2 1394 hard disk If a computer with FireNetTM contains two or more adapters connected on the same bus, FireNetTM will only be running on one of them, which will be drawn with the FireNet icon. The rest will contain only a speed code. Keep in mind that the NodeID assignment of 1394 is dynamic, and can change after each bus reset. Don't be surprised if the tree changes shape while you work! 42 ubCoreTM 3.1 User Guide Color and Pattern coding Depending on their speed, nodes are drawn in different colors. All colors will be displayed solid if your graphics adapter supports 256 colors or more. If your graphics mode is set to 16 colors, then the colors will be displayed dithered. The node on which the program is running (the local node) is always drawn in white with black letters. This way you can easily identify the node ID of the PC you are working on. The colors for all the other nodes are customizable through the Color dialog box: In order to change the color and text color for a speed code: 1) Select the speed code from the combo box titled "Speed code" 2) Left click on the desired color from the swatch on the left. The "Sample" area changes color according to your selection. 3) Left click on the desired text color from the swatch on the right. The "Sample" area changes text color according to your selection. 4) When satisfied with the result, press the "Apply" button to save the change for the specific speed code. The main window is redrawn immediately to reflect the changes, which will be retained after you dismiss the dialog box with the "Close button". Active 1394 nodes (i.e. whose configuration ROM can be read) are shown in solid color. Inactive nodes are drawn with a diagonal stripe. Active nodes are located every time a bus reset occurs, with random order, after a delay of approximately ½ sec. You can update the topology any time by selecting the Refresh command from the menu, or simply by pressing the F5 key, while the FireViewerTM window is active. 43 ubCoreTM 3.1 User Guide Adapter selection The topology shown each time is the one for the current adapter. For multi-adapter systems, you can select the current adapter as in the following picture. Up to 10 adapters are supported but only the present ones are shown in the menu. 44 ubCoreTM 3.1 User Guide Window appearance Node size The main program window can draw the bus topology with two different node sizes. There are two choices for node size: · · Small Nodes: Only the node ID is shown inside the node. This makes the FireViewerTM window consume less space, making it easier to keep visible all the time. Big Nodes: The node contains its node ID and speed code or icon. To switch between the two sizes select "View | Node size | Small" or "View | Node size | Big" from the menu. Ports Check the "View | Show Port" menu item to enable the display of port information. When this is enabled, then FireViewerTM shows the ports of each node, and the actual connections between the nodes. This can be of significant help when you have more than 3-4 PCs on the bus. There comes a point, when you can't remember which nodes connect to each other, and you have to trace the cables around in order to find out where each cable leads to. Ports are numbered left-to-right. The leftmost port is port 0, the middle one is port 1, and the rightmost port two. In devices with 1 or 2 ports, only one or two ports are displayed (unless the device reports differently as some one-port cameras do). The port that is connected to the parent node is drawn at the top edge of the node's rectangle. There is no line leading to an unconnected port. The FireViewerTM shows the first three ports of each node, whether they are present or not. Select again the "View | Show Port" menu item to disable the display of port information. Caption and menu bar The window can be shown with or without a caption and menu bar. Double-click the left mouse button inside the window to switch between the two views, or select "View | Hide title and menu" and/or "View | Show title and menu" from the menu. When the window does not have a caption and menu bar, you can move it by clicking with the left mouse button into the window and dragging it to the desired position. The "View" menu is accessed via the right mouse button. When the caption is visible, it shows the number of bus resets that have happened during the machine's uptime. Always on top Check the "View | Always on top" menu item to make the window topmost. If this menu item is unchecked, you can check the "View | Foreground on BR" menu item to have the window come to the foreground whenever a bus reset takes place. 45 ubCoreTM 3.1 User Guide Node Properties Right clicking on any active node will show a context menu that includes the Properties command. Selecting this command will display a small dialog box with information about that node. The information varies according to the node type. The next figure shows the contents of this dialog box which are common to all node types: The first line displays the node's Globally Unique IDentifier (GUID). The rest information is retrieved from the node's bus_info_block. Refer to the 1394 standard's documentation for a detailed explanation of these items. For FireNet nodes, the Properties dialog box looks like: 46 ubCoreTM 3.1 User Guide FireNet properties include the UNC name of the computer, its operating system, the FireNet version it is running, the emulated MAC address it uses and its MTU size. For digital cameras, the Properties dialog box is as follows: Extra information includes the camera vendor and model, as well as the specification number. Bus anomalies When an anomaly occurs on the bus, and a valid topology cannot be derived from the self-id packets, then the tree cannot be drawn accurately. In this case the last known topology is drawn dimmed. The application tries to communicate with any active nodes on the bus, and draws in solid color the ones that are still active. This situation might occur from time to time, especially when a device gets unplugged from the bus. It is usually corrected with a bus reset. The SBM driver checks for this condition and initiates a bus reset after a couple of seconds to correct the situation, so usually it won't be necessary to do this yourself. The communication between nodes is never halted due to a topology error, so you should not worry if this situation occurs. In the rare case when the problem persists, then there is some problem with some node on the bus. The only thing you might do in this case is disconnect a few devices from the bus until you restore a valid topology. In extremely rare cases, the problem might persist. Then you might have to reboot your PC, or shut it down, turn it off, remove all 1394 cables from it and then power it up again. This is a problem that has only occurred during our development, in cases where a serious software failure or driver crash has left the adapter in a state from which it cannot operate even after a warm reboot, but requires a complete power off. This also means disconnecting the adapter from the 1394 bus, because the bus itself supplies power to the adapter even when the PC is turned off. 47 ubCoreTM 3.1 User Guide Menu The menu bar of the window contains a "View" and "Help" menu. You can also access the "View" menu by right-clicking the mouse button inside the window. View menu · · · · · · · · · · · Properties: This item is available only when the "View" menu is opened by right-clicking the mouse on an active node. It opens a dialog box showing information about the node that is accessible via the configuration ROM. Adapter: Select from the popup menu that opens the adapter that will be the current. Node size: Select "Small" or "Big" to have the nodes drawn in small or big size, respectively. Show ports: Check or unckeck this item to enable or disable port drawing respectively. Customize colors: Opens the Color dialog box. Hide title and menu: Has the same effect as double-clicking the left mouse button in the window when the window has a caption and menu bar -orShow title and menu: Has the same effect as double-clicking the left mouse button in the window when the window does not have a caption and menu bar. Foreground on BR: Active only when the window is not topmost. Check this menu item to have the window come to the foreground whenever a bus reset occurs. Always on top: Check this menu item to make the window topmost. Refresh: Select this menu item or press the F5 key to retrieve again the bus topology and redraw the window. Exit: Select this menu item to terminate the program. Help menu · About: Shows copyright information, including the current version number of FireViewerTM. 48 ubCoreTM 3.1 User Guide FireCommanderTM1394 Command Interpreter The 1394 command interpreter is a tool that can be used to pass commands to the 1394 stack, for example sending transaction requests to various nodes and seeing the results, sending PHY packets, initiating bus resets etc. The 1394 command interpreter also has the ability to execute script files containing the commands that it recognizes. This capability can be used for the execution of elementary testing procedures. An important feature of FireCommanderTM is the built in utility bench that performs instant benchmarking and performance measurement of the connection between two (2) 1394 PC nodes. Please refer to this utility description for more details. The help command from within the interpreter provides the list of available commands and a summary of command syntax. Running the program Run the FireCommanderTM from the "Start Programs ubCore". It runs as a console process, by opening a text window similar to the system's command prompt. In this window you can type the various supported commands, and then press Enter so that the interpreter processes them. In the next screen capture you see the initial console information and the Unibrain's 1394 driver stack version executing the ver command 49 ubCoreTM 3.1 User Guide You can have open at the same time, as many instances of this program as you find suitable. Note that FIRECOMMANDER by default will sound the computer beeper twice whenever a bus reset occurs on the local bus. You can turn off this sound with the beep command. If a bus reset storm is detected (too many bus resets in a very short interval) the program will sound an alarm that will immediately notify the user that there is a problem on the network. You can test this alarm to see what it sounds like by running the alarm command. The output of FIRECOMMANDER is sometimes too big to fit in the traditional 80x25 command windows. It is suggested that you open the properties page of the command window (right-click on the window's title bar) and change the size of the window in order to be able to work more comfortably. Any kind of layout can be saved into the shortcut that started FIRECOMMANDER, and then be automatically reused each time you run it. 50