-
RabbitLink (EG2110) Network Programming Gateway User’s Manual 019–0123 • 070831–D
-
RabbitLink (EG2110) User’s Manual Part Number 019-0123 • 070831–D • Printed in U.S.A. ©2004–2007 Rabbit Semiconductor Inc. • All rights reserved. No part of the contents of this manual may be reproduced or transmitted in any form or by any means without the express written permission of Rabbit Semiconductor. Permission is granted to make one or more copies as long as the copyright page contained therein is included.
-
TABLE OF CONTENTS Chapter 1. Introduction 1 1.1 Overview...............................................................................................................................................2 1.2 RabbitLink Features..............................................................................................................................3 1.3 Development and Evaluation Tools......................................................................................................4 1.4 Software ....
-
Appendix C. Subsystems 31 C.1 RabbitLink Hardware Subsystems .................................................................................................... 32 C.1.1 Pinouts ....................................................................................................................................... 32 C.2 Serial Communication ....................................................................................................................... 33 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 the Rabbit-based system. The RabbitLink provides an indirect connection between the two for remote downloading and debugging of Rabbit-based systems using either the Rabbit 2000 or the Rabbit 3000 microprocessor.
-
1.1 Overview Microprocessor boards with a Rabbit microprocessor use a standardized programming connector. Using this connector it is possible to load new software as well as perform the various testing and debugging operations that are part of normal software development. The target can be initialized completely via the programming port without the need for preexisting code stored on the flash memory of the target board. The programming port is a 10-pin 2 mm header (Rabbit 2000-based boards) or a 10-pin 1.
-
1.2 RabbitLink Features The following is a list of RabbitLink hardware and software features. • Rabbit® 2000 microprocessor operating at 22.1 MHz. • RJ-45 Ethernet port compliant with IEEE 802.3 standard for 10Base-T Ethernet protocol. • 2 serial ports. • 3 status LEDs, labeled USER, ACT and LINK. • 128K static RAM and 512K flash memory (two 256K flash chips). • Optional plastic enclosure and LED light pipes (enclosure and light pipes are included with the tool kit, and are also sold separately).
-
1.3 Development and Evaluation Tools The RabbitLink board comes with two program download cables. These cables connect a Rabbit-based single-board computer to the RabbitLink board. They are functionally identical, differing in physical size to accommodate different Rabbit-based single-board computers. 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) Getting Started instructions.
-
1.4 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. Compatibility Between Dynamic C and the RabbitLink Firmware RabbitLink Firmware Dynamic C Rabbit Field Utility Version 1.00 Versions 7.
-
By default, the RabbitLink will try to get an IP address using DHCP. (DHCP is a protocol to automatically assign IP addresses to computers when they are booted.) The network addresses may be changed using the RabbitLink serial console. Please see Appendix 2.2, “Configuring RabbitLink Network Parameters from your PC,” for more information.
-
1.5 RabbitLink CE Compliance This section describes the immunity and emissions standards met by the RabbitLink. Design guidelines are given to help developers incorporate the RabbitLink into an application while staying CE compliant. Equipment is generally divided into two classes.
-
Emissions The RabbitLink meets the following emission standards with the Rabbit 2000 spectrum spreader turned on and set to the normal mode. The spectrum spreader is only available with revision C or higher of the Rabbit 2000 microprocessor. This microprocessor is used in all RabbitLink boards that carry the CE mark. • EN55022:1998 Class A • FCC Part 15 Class A NOTE: The RabbitLink satisfied the Class A limits but not the Class B limits.
-
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 Physical Connections 1. Attach the RabbitLink board to the plastic enclosure base. 15 90 65 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. Fla EP sh RO M Fla EP sh RO M SRAM Figure 3. Attach RabbitLink Board to Plastic Enclosure Base The plastic enclosure base facilitates handling the RabbitLink during development.
-
2. Connect the programming cable You must 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. Option 1 is an AC adapter to power supply jack J4; option 2 is a screw terminal header at J5. 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 LED labeled USER comes on for several seconds after power is applied.
-
2.2 Configuring RabbitLink Network Parameters from your PC There are two ways to set the basic network parameters for the RabbitLink: dynamically (DHCP) or statically (RabbitLink serial console). 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 easiest way to set network parameters is to use a DHCP server. This method is available starting with RabbitLink firmware version 2.00.
-
3. Configure the RabbitLink network parameters. This is done using the serial console commands. Typing the command “show” results in a listing of the current network addresses. Please refer to Appendix E, “Serial Console Commands,” for a description of all the commands. If a DHCP server was not used, the following serial console commands are required: set ip x.x.x.x set gateway x.x.x.x set netmask x.x.x.x // factory default is 10.10.1.100 // factory default is 10.10.1.1 // factory default is 255.255.255.
-
2.3 Target System Connections to the RabbitLink After the network addresses have been set, put aside the programming cable and connect the program download cable as shown in Figure 6. Two program download cables are included with the RabbitLink — one is used with 2 mm programming headers, and the other is used with 1.27 mm programming headers. One end of the program download cable connects to the programming header of the Rabbit-based target system. The other end connects to the PROG OUT header (J1 for 1.
-
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 in a TCP/IP Tool Kit. More information is available at www.rabbit.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.
-
• The Network Address field should contain the IP address of the RabbitLink. • The Control Port field should be set to the TCP port number that the RabbitLink uses to accept control commands from Dynamic C—the default value is 4244. If the RabbitLink is behind a firewall, the Control Port field should be set to the port on the firewall that is being forwarded to the RabbitLink.
-
3.1.6 Troubleshooting Tips • If Dynamic C is unable to establish communication with the RabbitLink, make sure that the RabbitLink is powered on, and make sure that the Ethernet cable is firmly connected to the RabbitLink and that the LED labeled LINK is on. • If Dynamic C is still unable to establish communication with the RabbitLink, make sure that Dynamic C has the correct IP address and control port information. Look in the Communications dialog box.
-
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 is ready to download a program to the local or remote Rabbit-based system. If it is necessary to reload or replace the firmware, the following .bin files are available for download from the RabbitLink directory that was created when Dynamic C installed. The .
-
2. Use the RFU version 2.0 or later to load the DOWNLOAD.BIN firmware or the CLEAR_PARAM.BIN binary image onto the RabbitLink board. 3. Disconnect the programming cable. 4. Unplug the power supply, then plug the power supply back in. This resets the RabbitLink from Program Mode to Run Mode. 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).
-
22 RabbitLink (EG2100)
-
APPENDIX A. SPECIFICATIONS Appendix A provides the specifications for the RabbitLink and describes the conformal coating.
-
A.1 Electrical and Mechanical Specifications 15 90 65 Figure A-1 shows the mechanical dimensions for the RabbitLink. All measurements are in inches followed by millimeters enclosed in parentheses. 2.13 3.43 (54) (87) Flash EPROM Flash EPROM Jacks extend 0.16" (4.0 mm) past edge of board SRAM 0.65 (16.5) 2.85 (72) 0.65 (16.5) 4.15 (105) 0.80 (20) 4.15 (105) Figure A-1. RabbitLink Dimensions NOTE: All measurements are in inches followed by millimeters enclosed in parentheses.
-
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.80" (87 mm × 105 mm × 20 mm) Connectors one RJ-45 (Ethernet) two 2 × 5, 2 mm pitch (serial programming) one 2 × 5, 1.
-
A.2 Conformal Coating C72 Y4 R30 15 90 65 The area around the crystal oscillator and the battery backup circuit on the RabbitLink has had the Dow Corning silicone-based 1-2620 conformal coating applied. The conformally coated area is shown in Figure A-2. The conformal coating protects these high-impedance circuits from the effects of moisture and contaminants over time. C38 Conformal Coating C37 Flash EPROM Flash EPROM SRAM Figure A-2.
-
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.
-
2. Install light pipes (optional). Light pipes are included in the tool kit so you can see the LEDs on the RabbitLink board once the enclosure is assembled. Notched side Light pipe flange is firmly against enclosure Figure B-2. Install Light Pipes in Enclosure Top With the enclosure top positioned as shown in Figure B-2, insert three light pipes into the slots identified in Figure B-2.
-
15 90 65 Notched side Fla EPRsh OM Fla EPRsh OM SRAM Figure B-3. Attach Enclosure Top 4. Mount plastic enclosure (optional). Use four #10 screws to attach the assembled plastic enclosure to the surface on which it will be mounted. This step applies to production versions of RabbitLink boards once development has been completed.
-
B.2 Dimensions Figure B-4 shows the dimensions for the plastic enclosure. 4.25 (108) 0.70 (18) 0.375" (9.5 mm) is cut off each corner 5.00 (127) 4.35 (110) 3.62 (92) 2.13 (54) 4.875 (124) 1.375 (35) 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 This appendix describes the principal RabbitLink subsystems.
-
C.1 RabbitLink Hardware Subsystems Figure C-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. PA0 PB2 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 BUFEN RESET PD1 PD2 PD0 Port B Port A Programming Ports PC6PC7 PB0 PB1 PB6 PB7 Misc.
-
C.2 Serial Communication The RabbitLink uses two serial ports of the Rabbit 2000 microprocessor. C.2.1 Serial Programming Ports The RabbitLink board has two 10-pin programming headers labeled J8 and J9. The PROG IN (J8) header uses the Rabbit 2000’s serial port A for communication, and PROG OUT (J9) uses serial port B.
-
C.3 Memory The RabbitLink has SRAM and flash memory devices. The Dynamic C BIOS handles different standard RAM and flash memory sizes automatically. C.3.1 SRAM The RabbitLink is designed to accept 128K or 512K of SRAM packaged in an SOIC case. It comes standard with 128K of SRAM. Figure C-3 shows the locations and the jumper settings for the jumpers at JP4 used to set the SRAM size. The jumpers are 0 Ω surfacemount 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. The connection through jack J4 is protected against reverse polarity by a Schottky diode at D1 as shown in Figure C-4. POWER IN J4 J5 J5 SWITCHING POWER REGULATOR +RAW 1 2 D1 3 14 C8 47 µF 6 15 8 1 12 1 LM2575 U16 Vcc 7 17 18 10 2 1 4 330 µH D2 L1 1N5819 3 C1 330 µF Figure C-4.
-
36 RabbitLink (EG2110)
-
APPENDIX D. PROGRAMMING CABLE This appendix provides technical information about the Rabbit 2000 microprocessor when connecting the RabbitLink and a PC via a programming cable. The programming cable has two connectors, labeled DIAG and PROG. The programming cable connects the PC’s COM port to the programming port, which is header J8, on the RabbitLink. The programming port pin assignments are shown in Figure D-1.
-
The DIAG Connector The DIAG connector is used to configure network parameters for the RabbitLink. It is also used to treat the programming port as a regular serial port; because the programming cable contains an active circuit board that converts RS-232 voltage levels used by the PC serial port to CMOS voltage levels used by the Rabbit, the DIAG connector allows the programming cable to be used as an RS-232 to CMOS level converter for serial communication.
-
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.
-
E.1 Configuration Commands These commands are used to set network parameters and to password-protect the RabbitLink. set consbaud This command sets the baud rate of the console communications. 57600 57,600 is the default console baud rate. 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.1.1.
-
set passphrase This command will prompt for a passphrase twice to confirm that the passphrase was entered correctly. The characters are not echoed back as a security measure. As another security measure, the passphrase is hashed before it is stored on the RabbitLink. Whenever a new session starts with Dynamic C or the RFU, the user will be asked for the passphrase. It should be as long as possible to increase security, up to the maximum length of 255 characters.
-
E.2 Variables Commands The RabbitLink serial console has the ability to handle SSI (Server Side Includes) variables. These variables are stored in an xmem buffer. This means that the memory will lose the variables when power is cycled, although the references to the variables will still exist. Remember that any HTML file that includes SSI tags must have the file extension .shtml.
-
list variables This command lists all the variables by name and type that are stored in the flash file system on the RabbitLink. reset variables This command deletes all the variables that are stored in the flash file system on the RabbitLink.
-
E.3 File Commands delete Deletes the specified file from the flash file system on the RabbitLink. filename Identifies the file to delete. get This command returns the contents of the specified file. filename Identifies the file. 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.
-
put This command sends a binary file to the flash file system on the RabbitLink. There is a timeout 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. size The number of bytes in the file being transferred.
-
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 Function Call (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 function calls described in this section will be recognized by the RabbitLink. Prior to Dynamic C 7.20 these functions were in STDIO.LIB.
-
ConsoleFinish 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.
-
E.7 Example Using the RabbitLink Console Function Call main() { // first method SendToConsole("set ip 10.10.2.102\n", 19); // second method PrintToConsole(1); printf("set gateway 10.10.2.
-
INDEX A F R AC adapter ............................ 12 Rabbit Field Utility (RFU) ... 16 reset generator ....................... 35 RJ-45 Ethernet jack .............. 16 broadcast packet .................... 18 firmware ............................ 5, 20 download ........................... 20 upgrades ............................ 21 function calls ......................... 48 C H CE compliance design guidelines ................. 8 CE mark .................................. 7 CLEAR_PARAM.BIN ......
-
52 RabbitLink (EG2110)
-
SCHEMATICS 090-0168 RabbitLink (EG2110) Schematic www.rabbit.com/documentation/schemat/090-0168.pdf 090-0128 Programming Cable Schematic www.rabbit.com/documentation/schemat/090-0128.pdf You may use the URL information provided above to access the latest schematics directly.
-
