-
RabbitLink (EG2100) Network Programming Gateway User’s Manual 019–0090 • 020222–B
-
RabbitLink (EG2100) User’s Manual Part Number 019-0090 • 020222–B • Printed in U.S.A. ©2001 Z-World Inc. • All rights reserved. Z-World reserves the right to make changes and improvements to its products without providing notice. Notice to Users Z-WORLD PRODUCTS ARE NOT AUTHORIZED FOR USE AS CRITICAL COMPONENTS IN LIFE-SUPPORT DEVICES OR SYSTEMS UNLESS A SPECIFIC WRITTEN AGREEMENT REGARDING SUCH INTENDED USE IS ENTERED INTO BETWEEN THE CUSTOMER AND Z-WORLD PRIOR TO USE.
-
TABLE OF CONTENTS Chapter 1. Introduction 1 1.1 RabbitLink Features..............................................................................................................................1 1.2 Development and Evaluation Tools......................................................................................................2 1.2.1 Manual Conventions .....................................................................................................................3 1.3 Software ..................
-
C.1 RabbitLink Hardware Subsystems .................................................................................................... 24 C.1.1 Pinouts ....................................................................................................................................... 24 C.2 Serial Communication ....................................................................................................................... 25 C.2.1 Serial Programming Ports..........................................
-
1. INTRODUCTION This chapter introduces the RabbitLink Network Programming Gateway and describes its features. Rabbit-based embedded systems are normally programmed using a direct connection between a PC and the programming port of a Rabbit-based embedded system. The RabbitLink provides an indirect connection between the two for remote downloading and debugging. Ethernet Port Ethernet/ Internet RabbitLink Board Rabbit-based embedded system Programming Port Figure 1.
-
1.2 Development and Evaluation Tools The RabbitLink board comes with a program download cable. This cable connects a Rabbit-based controller to the RabbitLink board. The RabbitLink tool kit (sold separately from the RabbitLink board) contains other hardware that may be used with the RabbitLink. The tool kit contents are: • RabbitLink (EG2100) User’s Manual with schematics (this document).
-
1.2.1 Manual Conventions A black square indicates pin 1 of all headers. J1 Pin 1 1.3 Software The RabbitLink board is shipped with firmware already installed in the flash memory. The rows in the following table show which versions of Dynamic C and the RFU are compatible with which versions of the RabbitLink firmware. The firmware version is the same as its serial console; the version number is displayed in the console’s startup message. Table 1.
-
4 RabbitLink (EG2100)
-
2. GETTING STARTED This chapter shows how to make the necessary hardware connections and how to configure the network parameters for the RabbitLink. 2.1 RabbitLink Connections 1. Attach the RabbitLink board to the plastic enclosure base. Position the RabbitLink board over the plastic enclosure base as shown below in Figure 3. Attach the RabbitLink board to the base at the top left and bottom right positions using the two 4-40 × ¼ screws supplied.
-
2. Connect the programming cable to configure network parameters from your PC. Connect the 10-pin DIAG connector of the programming cable to header J8, which is labeled PROG IN, on the RabbitLink. Ensure that the colored edge lines up with pin 1 as shown. Connect the other end of the programming cable to a COM port on your PC.
-
3. Connect the power supply. Two options are available for powering the RabbitLink—via an AC adapter to power supply jack J4, or through a screw terminal header at J5/J6. Option 1 is most convenient in a desktop environment, and Option 2 can be used to connect the RabbitLink to an existing power supply in a field installation. The red USER LED comes on once power is applied successfully.
-
2.2 Configuring RabbitLink Network Parameters from Your PC There are two ways to set the basic network parameters for the RabbitLink. The basic network parameters are: • the IP address of the RabbitLink • the IP address of the gateway • the netmask 2.2.1 Dynamically Assigned Network Parameters The first, and easiest, way to set network parameters is to use a DHCP server. This method is available starting with RabbitLink firmware version 2.00.
-
The RabbitLink boots up whenever the power cycles, and then displays the message, RabbitLink Serial Console Version X.XX The RabbitLink serial console will respond OK after each command, or, “ERROR ” if something went wrong. 2.3 Target System Connections to the RabbitLink After network addresses have been set, put aside the programming cable and connect the program download cable as shown in Figure 6.
-
2.4 Ethernet Connections Before proceeding, you will need to have either two straight-through Ethernet cables and an Ethernet hub or one Ethernet crossover cable. The Ethernet cables and Ethernet hub are available from Rabbit Semiconductor or Z-World in a TCP/IP tool kit. More information is available at www.rabbitsemiconductor.com or at www.zworld.com Your PC must have an RJ-45 Ethernet jack.
-
3. RABBITLINK SOFTWARE This chapter describes the software functionality available when using a RabbitLink. 3.1 Downloading and Debugging via the RabbitLink Downloading a program to an embedded target via the RabbitLink is done using Dynamic C or the Rabbit Field Utility (RFU). The rows in the following table show which versions of Dynamic C and the RFU are compatible with which versions of the RabbitLink firmware.
-
3.1.3 Password Protect the Embedded Target Though not required, it is highly recommended that the passphrase security feature be activated before the RabbitLink is deployed. This gives some protection to the embedded target system from unauthorized communication. The passphrase may be up to 256 characters long. The serial console command “set passphrase” will prompt twice for a passphrase and will store the hashed value of it on the RabbitLink.
-
3.2 RabbitLink Firmware The firmware necessary to operate the RabbitLink with a Rabbit-based target system is loaded at the factory. This means that after the hardware connections have been made and the network parameters configured, the RabbitLink may be used immediately to download a program to the local or remote Rabbit-based system.
-
3.2.2 Firmware Upgrades Follow the above steps to install a firmware upgrade. Just substitute the name of the firmware upgrade for the firmware binary image file (DOWNLOAD.BIN ). Firmware upgrades will be available at www.rabbitsemiconductor.com or at www.zworld.com 3.3 Serving Web Pages and Sending E-Mail The RabbitLink is primarily intended for downloading and debugging across an Ethernet-based network with a Rabbit-based target. 3.3.
-
APPENDIX A. SPECIFICATIONS Appendix A provides the specifications for the RabbitLink and describes the conformal coating.
-
A.1 Electrical and Mechanical Specifications Figure A-1 shows the mechanical dimensions for the RabbitLink. DCIN GND IN0 IN1 IN2 IN3 GND GND GND R14 R16 R18 R15 R17 R19 C26 C27 C25 J6 JP1 R25 R24 R23 R22 R8 R21 R20 + C19 + R7 R6 C18 R12 R13 C24 GND Y1 GND J5 J7 GND BT1 C40 C41 C42 Q1 Q2 Q3 D5 D6 D7 R36 R37 R38 Y3 C9 R44 PWR LNK1 (87) 3.43 (54) 2.
-
Table A-1 lists the electrical, mechanical, and environmental specifications for the RabbitLink. Table A-1. RabbitLink Specifications Parameter Specification Board Size 3.43" × 4.15" × 0.
-
A.2 Conformal Coating The areas around the crystal oscillator and the battery backup circuit on the RabbitLink have had the Dow Corning silicone-based 1-2620 conformal coating applied. The conformally coated areas are shown in Figure A-2. The conformal coating protects these highimpedance circuits from the effects of moisture and contaiminants over time.
-
APPENDIX B. PLASTIC ENCLOSURE The plastic enclosure provides a secure way to enclose your RabbitLink board. The enclosure itself may be mounted on any flat surface. Appendix B describes how to mount the RabbitLink board inside the plastic enclosure, how to install the optional light pipes, and provides details on mounting the assembly.
-
B.1 Assembly 1. Attach the RabbitLink board to the plastic enclosure base. Position the RabbitLink board over the plastic enclosure base as shown below in Figure B-1. Attach the RabbitLink board to the base using the two 4-40 × ¼ screws supplied.
-
cyanoacrylate or contact cement to the inside of the enclosure around each light pipe to hold it in place. NOTE: Once the glue is applied, it will not be possible to change the alignment of the light pipes without damaging the plastic enclosure. 3. Attach the enclosure top to the base. Position the enclosure top over the plastic enclosure base as shown below in Figure B-3. Attach the enclosure top to the base using the two 4-40 × ½ screws supplied.
-
B.2 Dimensions 4. (1 25 08 ) Figure B-4 shows the dimensions for the plastic enclosure. 0.70 (18) 0.375" (9.5 mm) is cut off each corner 5.00 (127) 4.35 (1 75 24 ) 4.8 1.3 (3 75 5) 2.1 (5 3 4) 3.6 (9 2 2) (110) 0.25 (6.4) 2.85 (72) 1.375 (35) 5.60 (142) Figure B-4. Plastic Enclosure Dimensions When fully assembled with the RabbitLink installed, the total height of the plastic enclosure will be 1.1" (28 mm).
-
APPENDIX C. SUBSYSTEMS Appendix D describes the principal subsystems for the RabbitLink.
-
C.1 RabbitLink Hardware Subsystems Figure D-1 shows the Rabbit-based subsystems designed into the RabbitLink and shows the parallel ports and signal lines they use on the Rabbit 2000 microprocessor. BUFEN RESET PD2 Port D Programming Out Port RabbitLink CPU (RABBIT 2000) Port E Programming In Port Real-Time Clock Misc. Output Watchdog Serial Port (Port C) PC4PC5 PD0 Port B Port A Programming Ports PC6PC7 PB1 PB6 PB7 PB0 PB2 PA0 Misc.
-
C.2 Serial Communication C.2.1 Serial Programming Ports The RabbitLink board has two 10-pin programming headers labeled J8 and J9. The PROG IN port uses the Rabbit 2000’s serial port A for communication, and the PROG OUT port uses serial port B.
-
C.3 Memory C.3.1 SRAM The RabbitLink is designed to accept 128K or 512K of SRAM packaged in an SOIC case. The standard models sold by Z-World and by Rabbit Semiconductor come with 128K of SRAM. Figure D-3 shows the locations and the jumper settings for the jumpers at JP4 used to set the SRAM size. The “jumpers” are 0 Ω surface-mounted resistors.
-
C.4 Power Supplies Power is supplied to the RabbitLink board from an external source either through jack J4 or through screw terminal connector J5/J6. The connection through jack J4 is protected against reverse polarity by a Sshottky diode at D1 as shown in Figure D-4, but the alternative connection through J5/J6 is not protected against reverse polarity.
-
28 RabbitLink (EG2100)
-
APPENDIX D. PROGRAMMING CABLE Appendix E provides additional information for the Rabbit 2000™ microprocessor when using the DIAG and PROG connectors on the programming cable with the RabbitLink board. The PROG connector is used only when the programming cable is attached to the PROG IN connector (header J8) on the RabbitLink to download new firmware.
-
The programming port, which is shown in Figure E-1, can serve as a convenient communications port for field setup or other occasional communication need (for example, as a diagnostic port). If the port is simply to perform a setup function, that is, write setup information to flash memory, then the controller can be reset through the programming port and a cold boot performed to start execution of a special program dedicated to this functionality.
-
APPENDIX E. SERIAL CONSOLE COMMANDS This appendix describes the RabbitLink serial console commands. The serial console was designed to be human-accessible as a convenient way to setup the network configuration. It is possible to use these commands programatically from the target, though it is not recommended. If Internet services are desired, Z-World suggests the DeviceMate software, which may be run on the RabbitLink board.
-
E.1 Configuration Commands These commands are used to set network parameters and to password protect the RabbitLink. set gateway This command sets the IP address for the gateway. IP address The IP address for the gateway in dotted decimal format. The factory default is 10.10.6.1. set hostname This command allows the RabbitLink to be identified with a unique name, that may be up to 40 characters long. name User-chosen string. The factory default is RabbitLink.
-
set port x This command sets the TCP port number. If the RabbitLink is being used behind a firewall, it may be necessary to punch a hole in the firewall to allow remote access. x The port number. The factory default is 4244. set dhcp This command enables and disables the use of any DHCP server that is available on the network. The default condition is on. This command is only available with RabbitLink serial console version 2.00. E.
-
getv This command gets the value of the specified variable. The value is printed using the format specifier given in the createv command. varname The variable whose value is requested. putv This command assigns the specified value to the specified variable. varname The variable whose value is being changed. value The new value for the variable. list variables This command lists all the variables by name and type that are stored in the flash file system on the RabbitLink.
-
list files This command lists all the files in the flash file system on the RabbitLink. put This command sends an ASCII file to the flash file system on the RabbitLink. There is a time-out for this command: the data transfer begins no later than 60 seconds after the RabbitLink senses there is no activity. NOTE: It is faster and more efficient to transfer all files, including ASCII files, as binary files. filename Identifies the file.
-
E.4 E-Mail Commands mail The mail command sends an e-mail via the RabbitLink to the specified address. e-mail address The address to which the e-mail is sent; e.g. rabbit@warren.com. subject After receiving the mail command, the RabbitLink will accept the next string as the subject of the e-mail body After receiving the subject of the e-mail, the RabbitLink will accept strings that follow as the body of the e-mail.
-
E.5 Other Console Commands echo This command toggles the echoing of characters. help [filename] This command displays the online help. filename This optional parameter limits the help information to that which is associated with the specified file. reset This command resets the basic network parameters (the netmask and the IP addresses of the RabbitLink and its gateway) to factory defaults.
-
E.6 RabbitLink Console API (prior to Dynamic C 7.20) The RabbitLink serial console may be accessed via the serial port using the PROG IN connector on the RabbitLink, as was done in Chapter 2 to configure the RabbitLink. If RabbitLink firmware version 1.00 is being used, the API functions described in this section will be recognized by the RabbitLink. Prior to Dynamic C 7.20 these functions were in STDIO.LIB.
-
int ConsoleFinish(long timeout); int ConsoleFinish(long timeout); This function finishes receiving data from the RabbitLink serial console by blocking for an optional amount of time to do it. If the timeout is set to 0, the function will not receive any data, but will poll to determine whether there are more data to receive. PARAMETERS timeout The length of time to time out, in milliseconds, and is 0 for ConsoleFinish() to determine whether there are more data to receive.
-
40 RabbitLink (EG2100)
-
INDEX A AC adapter .............................. 7 C configuration ........................... 8 echo on ................................ 8 terminal emulator ................ 8 connections firmware download ........... 13 program download cable ..... 9 target system ....................... 9 console commands echo ..................................... 8 set mail from ..................... 36 set mail server ................... 36 set passphrase .................... 32 set port .............................
-
42 RabbitLink (EG2100)
-
SCHEMATICS 090-0112 RabbitLink (EG2100) Schematic www.rabbitsemiconductor.com/documentation/schemat/090-0112.pdf 090-0085 Programming Cable Schematic www.rabbitsemiconductor.com/documentation/schemat/090-0085.pdf The schematics included with the printed manual were the latest revisions available at the time the manual was last revised. The online versions of the manual contain links to the latest revised schematic on the Web site.
-
