RabbitCore RCM3309/RCM3319
C-Programmable Core Module
with Serial Flash Mass Storage and Ethernet
User’s Manual
019–0166 •
080528–C
RabbitCore RCM3309/RCM3319 User’s Manual
Part Number 019-0166 • 080528–C • Printed in U.S.A.
©2008 Digi International 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 Digi International.
Permission is granted to make one or more copies as long as the copyright page contained therein is
included. These copies of the manuals may not be let or sold for any reason without the express written
permission of Digi International.
Digi International reserves the right to make changes and
improvements to its products without providing notice.
Trademarks
Rabbit, RabbitCore, and Dynamic C are registered trademarks of Digi International Inc.
The latest revision of this manual is available on the Rabbit Web site, www.rabbit.com,
for free, unregistered download.
Rabbit Semiconductor Inc.
www.rabbit.com
RabbitCore RCM3309/RCM3319
TABLE OF CONTENTS
Chapter 1. Introduction
1
1.1 RCM3309/RCM3319 Features .............................................................................................................2
1.2 Comparing the RCM3309/RCM3319 and RCM3305/RCM3315 ........................................................4
1.3 Advantages of the RCM3309 and RCM3319.......................................................................................5
1.4 Development and Evaluation Tools......................................................................................................6
1.4.1 RCM3309/RCM3319 Development Kit .......................................................................................6
1.4.2 Software ........................................................................................................................................7
1.4.3 Connectivity Interface Kits ...........................................................................................................7
1.4.4 Online Documentation ..................................................................................................................7
Chapter 2. Getting Started
9
2.1 Install Dynamic C .................................................................................................................................9
2.2 Hardware Connections........................................................................................................................10
2.2.1 Step 1 — Attach Module to Prototyping Board..........................................................................10
2.2.2 Step 2 — Connect Programming Cable ......................................................................................11
2.2.3 Step 3 — Connect Power ............................................................................................................12
2.3 Starting Dynamic C ............................................................................................................................13
2.4 Run a Sample Program .......................................................................................................................13
2.4.1 Troubleshooting ..........................................................................................................................13
2.5 Where Do I Go From Here? ...............................................................................................................14
2.5.1 Technical Support .......................................................................................................................14
Chapter 3. Running Sample Programs
15
3.1 Introduction.........................................................................................................................................15
3.2 Sample Programs ................................................................................................................................16
3.2.1 Use of Serial Flash ......................................................................................................................17
3.2.1.1 Onboard Serial Flash.......................................................................................................... 17
3.2.1.2 SF1000 Serial Flash Card................................................................................................... 17
3.2.2 Serial Communication.................................................................................................................17
3.2.3 Real-Time Clock .........................................................................................................................19
3.2.4 RabbitNet ....................................................................................................................................19
3.2.5 Other Sample Programs ..............................................................................................................19
Chapter 4. Hardware Reference
21
4.1 RCM3309/RCM3319 Digital Inputs and Outputs ..............................................................................22
4.1.1 Memory I/O Interface .................................................................................................................27
4.1.2 LEDs ...........................................................................................................................................27
4.1.3 Other Inputs and Outputs ............................................................................................................27
4.2 Serial Communication ........................................................................................................................28
4.2.1 Serial Ports ..................................................................................................................................28
4.2.2 Ethernet Port ...............................................................................................................................29
4.2.3 Serial Programming Port.............................................................................................................30
4.3 Programming Cable ............................................................................................................................31
4.3.1 Changing Between Program Mode and Run Mode ....................................................................31
4.3.2 Standalone Operation of the RCM3309/RCM3319....................................................................32
User’s Manual
4.4 Other Hardware .................................................................................................................................. 33
4.4.1 Clock Doubler ............................................................................................................................ 33
4.4.2 Spectrum Spreader...................................................................................................................... 33
4.5 Memory .............................................................................................................................................. 34
4.5.1 SRAM......................................................................................................................................... 34
4.5.2 Flash EPROM............................................................................................................................. 34
4.5.3 Serial Flash ................................................................................................................................. 34
4.5.4 Dynamic C BIOS Source Files................................................................................................... 34
Chapter 5. Software Reference
35
5.1 More About Dynamic C ..................................................................................................................... 35
5.1.1 Developing Programs Remotely with Dynamic C ..................................................................... 37
5.2 Dynamic C Functions........................................................................................................................ 38
5.2.1 Digital I/O................................................................................................................................... 38
5.2.2 SRAM Use.................................................................................................................................. 38
5.2.3 Serial Communication Drivers ................................................................................................... 39
5.2.4 TCP/IP Drivers ........................................................................................................................... 39
5.2.5 Serial Flash Drivers .................................................................................................................... 39
5.2.6 Prototyping Board Function Calls .............................................................................................. 40
5.2.6.1 Board Initialization ............................................................................................................ 40
5.2.6.2 Digital I/O.......................................................................................................................... 41
5.2.6.3 Switches, LEDs, and Relay ............................................................................................... 43
5.2.6.4 Serial Communication ....................................................................................................... 46
5.2.6.5 RabbitNet Port ................................................................................................................... 47
5.3 Upgrading Dynamic C ....................................................................................................................... 49
5.3.1 Extras.......................................................................................................................................... 49
Chapter 6. Using the TCP/IP Features
51
6.1 TCP/IP Connections ........................................................................................................................... 51
6.2 TCP/IP Primer on IP Addresses ......................................................................................................... 53
6.2.1 IP Addresses Explained.............................................................................................................. 55
6.2.2 How IP Addresses are Used ....................................................................................................... 56
6.2.3 Dynamically Assigned Internet Addresses................................................................................. 57
6.3 Placing Your Device on the Network ................................................................................................ 58
6.4 Running TCP/IP Sample Programs.................................................................................................... 59
6.4.1 How to Set IP Addresses in the Sample Programs..................................................................... 60
6.4.2 How to Set Up your Computer for Direct Connect.................................................................... 61
6.5 Run the PINGME.C Sample Program................................................................................................ 62
6.6 Running Additional Sample Programs With Direct Connect ............................................................ 62
6.6.1 RabbitWeb Sample Programs..................................................................................................... 63
6.6.2 Remote Application Update ....................................................................................................... 63
6.6.3 Dynamic C FAT File System, RabbitWeb, and SSL Libraries.................................................. 63
6.7 Where Do I Go From Here? ............................................................................................................... 65
Appendix A. RCM3309/RCM3319 Specifications
67
A.1 Electrical and Mechanical Characteristics ........................................................................................ 68
A.1.1 Headers ...................................................................................................................................... 72
A.2 Bus Loading ...................................................................................................................................... 73
A.3 Rabbit 3000 DC Characteristics ........................................................................................................ 76
A.4 I/O Buffer Sourcing and Sinking Limit............................................................................................. 77
A.5 Jumper Configurations ...................................................................................................................... 78
A.6 Conformal Coating ............................................................................................................................ 80
Appendix B. Prototyping Board
81
B.1 Introduction ....................................................................................................................................... 82
B.1.1 Prototyping Board Features ....................................................................................................... 83
B.2 Mechanical Dimensions and Layout ................................................................................................. 85
RabbitCore RCM3309/RCM3319
B.3 Power Supply .....................................................................................................................................87
B.4 Using the Prototyping Board..............................................................................................................88
B.4.1 Adding Other Components.........................................................................................................89
B.4.2 Digital I/O...................................................................................................................................90
B.4.2.1 Digital Inputs ..................................................................................................................... 90
B.4.3 CMOS Digital Outputs ...............................................................................................................91
B.4.4 Sinking Digital Outputs..............................................................................................................91
B.4.5 Relay Outputs .............................................................................................................................91
B.4.6 Serial Communication ................................................................................................................92
B.4.6.1 RS-232 ............................................................................................................................... 93
B.4.6.2 RS-485 ............................................................................................................................... 94
B.4.7 RabbitNet Ports ..........................................................................................................................95
B.4.8 Other Prototyping Board Modules .............................................................................................96
B.4.9 Quadrature Decoder ...................................................................................................................96
B.4.10 Stepper-Motor Control .............................................................................................................96
B.5 Prototyping Board Jumper Configurations ........................................................................................98
B.6 Use of Rabbit 3000 Parallel Ports ....................................................................................................100
Appendix C. LCD/Keypad Module
103
C.1 Specifications ...................................................................................................................................103
C.2 Contrast Adjustments for All Boards ...............................................................................................105
C.3 Keypad Labeling ..............................................................................................................................106
C.4 Header Pinouts .................................................................................................................................107
C.4.1 I/O Address Assignments.........................................................................................................107
C.5 Mounting LCD/Keypad Module on the Prototyping Board ............................................................108
C.6 Bezel-Mount Installation..................................................................................................................109
C.6.1 Connect the LCD/Keypad Module to Your Prototyping Board...............................................111
C.7 Sample Programs .............................................................................................................................112
C.8 LCD/Keypad Module Function Calls ..............................................................................................113
C.8.1 LCD/Keypad Module Initialization..........................................................................................113
C.8.2 LEDs.........................................................................................................................................114
C.8.3 LCD Display.............................................................................................................................115
C.8.4 Keypad......................................................................................................................................151
Appendix D. Power Supply
159
D.1 Power Supplies.................................................................................................................................159
D.1.1 Battery Backup.........................................................................................................................159
D.1.2 Battery-Backup Circuit ............................................................................................................160
D.1.3 Reset Generator .......................................................................................................................161
Appendix 0. RabbitNet
163
E.1 General RabbitNet Description ........................................................................................................163
E.1.1 RabbitNet Connections.............................................................................................................163
E.1.2 RabbitNet Peripheral Cards ......................................................................................................164
E.2 Physical Implementation ..................................................................................................................165
E.2.1 Control and Routing .................................................................................................................165
E.3 Function Calls...................................................................................................................................166
E.3.1 Status Byte................................................................................................................................178
Index
179
Schematics
183
User’s Manual
RabbitCore RCM3309/RCM3319
1. INTRODUCTION
The RCM3309 and RCM3319 RabbitCore modules feature a
compact module that incorporates the latest revision of the powerful Rabbit® 3000 microprocessor, flash memory, mass storage
(serial flash), static RAM, and digital I/O ports. The RCM3309
and RCM3319 feature an integrated 10/100Base-T Ethernet port,
and provide for LAN and Internet-enabled systems to be built as
easily as serial-communication systems.
In addition to the features already mentioned above, the RCM3309 and RCM3319 have
two clocks (main oscillator and real-time clock), reset circuitry, and the circuitry necessary
for management of battery backup of the Rabbit 3000’s internal real-time clock and the
static RAM. Two 34-pin headers bring out the Rabbit 3000 I/O bus lines, parallel ports,
and serial ports.
The RCM3309’s and the RCM3319’s mass-storage capabilities make them suited to running
the Dynamic C FAT file system module and the featured remote application update where
data are stored and handled using the same directory file structure commonly used on PCs.
The RCM3309 or RCM3319 receives +3.3 V power from the customer-supplied motherboard on which it is mounted. The RCM3309 and RCM3319 can interface with all kinds
of CMOS-compatible digital devices through the motherboard.
The Development Kit has what you need to design your own microprocessor-based
system: a complete Dynamic C software development system and a Prototyping Board
that allows you to evaluate the RCM3309 or RCM3319, and to prototype circuits that
interface to the RCM3309 or RCM3319 module.
User’s Manual
1
1.1 RCM3309/RCM3319 Features
• Small size: 1.85" x 2.73" x 0.86"
(47 mm x 69 mm x 22 mm)
• Microprocessor: Rabbit 3000 running at 44.2 MHz
• 10/100Base-T auto MDI/MDIX Ethernet port chooses Ethernet interface automatically
based on whether a crossover cable or a straight-through cable is used in a particular
setup
• 49 parallel 5 V tolerant I/O lines: 43 configurable for I/O, 3 fixed inputs, 3 fixed outputs
• Three additional digital inputs, two additional digital outputs
• External reset
• Alternate I/O bus can be configured for 8 data lines and 6 address lines (shared with
parallel I/O lines), plus I/O read/write
• Ten 8-bit timers (six cascadable) and one 10-bit timer with two match registers
• 512K flash memory, 512K program execution SRAM, 512K data SRAM
• 4MB/8MB mass-storage flash-memory options, which are required to run the Dynamic C
FAT file system module and the featured remote application update.
• Real-time clock
• Watchdog supervisor
• Provision for customer-supplied backup battery via connections on header J4
• 10-bit free-running PWM counter and four pulse-width registers
• Two-channel Input Capture (shared with parallel I/O ports) can be used to time input
signals from various port pins
• Two-channel Quadrature Decoder accepts inputs from external incremental encoder
modules
• Five or six 3.3 V CMOS-compatible serial ports with a maximum asynchronous baud
rate of 5.525 Mbps. Three ports are configurable as a clocked serial port (SPI), and two
ports are configurable as SDLC/HDLC serial ports (shared with parallel I/O ports).
• Supports 1.15 Mbps IrDA transceiver
The RCM3900/RCM3910 and RCM3365/RCM3375 RabbitCore modules are similar to
the RCM3305/RCM3315 and RCM3309/RCM3319, but they use fixed NAND and/or
removable media for their mass-storage memories instead of the fixed serial flash options
of the RCM3305/RCM3315 and the RCM3309/RCM3319.
2
RabbitCore RCM3309/RCM3319
Table 1 below summarizes the main features of the RCM3309 and the RCM3319 modules.
Table 1. RCM3309/RCM3319 Features
Feature
Microprocessor
SRAM
RCM3309
Rabbit 3000 running at 44.2 MHz
512K program (fast SRAM) + 512K data
Flash Memory
(program)
Flash Memory
(mass data
storage)
Serial Ports
RCM3319
512K
8MB
(serial flash)
4MB
(serial flash)
5 shared high-speed, 3.3 V CMOS-compatible ports:
all 5 are configurable as asynchronous serial ports;
3 are configurable as a clocked serial port (SPI) and 1 is
configurable as an HDLC serial port;
option for second HDLC serial port at the expense of 2
clocked serial ports (SPI)
The RCM3309 and RCM3319 are programmed over a standard PC serial port through a
programming cable supplied with the Development Kit, and can also be programed directly
over an Ethernet link using the featured remote application update or the Dynamic C
download manager with or without a RabbitLink.
Appendix A provides detailed specifications for the RCM3309 and the RCM3319.
User’s Manual
3
1.2 Comparing the RCM3309/RCM3319 and RCM3305/RCM3315
• Temperature Specifications — We can no longer obtain certain components for the
RCM3305/RCM3315 RabbitCore modules that support the -40°C to +70°C temperature
range. RCM3305/RCM3315 RabbitCore modules manufactured after May, 2008, are
specified to operate at 0°C to +70°C. The RCM3309/RCM3319, rated for -40°C to
+85°C, are offered to customers requiring a larger temperature range after May, 2008.
• Maximum Current — The RCM3305/RCM3315 draws 250 mA vs. the 325 mA
required by the RCM3309/RCM3319.
• LEDs — The SPEED and user (USR/BSY)LED locations have been swapped between
the RCM3305/RCM3315 and the RCM3309/RCM3319, the LNK/ACT LEDs have
been combined to one LED on the RCM3309/RCM3319, and the RCM3309/RCM3319
has an FDX/COL LED instead of the SF LED on the RCM3305/RCM3315. The SF
LED on the RCM3305/RCM3315 blinks when data are being written to or read from
the serial flash. The FDX/COL LED on the RCM3309/RCM3319 indicates whether the
Ethernet connection is in full-duplex mode (steady on) or that a half-duplex connection
is experiencing collisions (blinks).
NOTE: The change in LED indicators means that there is no indication on the
RCM3309/RCM3319 when data are being written to or read from the serial flash.
• Ethernet chip. A different Ethernet controller chip is used on the RCM3309/RCM3319.
The Ethernet chip is able to detect automatically whether a crossover cable or a straightthrough cable is being used in a particular setup, and will configure the signals on the
Ethernet jack interface.
• Dynamic C — As long as no low-level FAT file system calls were used in your application developed for the RCM3305/RCM3315, you may run that application on the
RCM3309/RCM3319 after you recompile it using Dynamic C v. 9.60.
4
RabbitCore RCM3309/RCM3319
1.3 Advantages of the RCM3309 and RCM3319
• Fast time to market using a fully engineered, “ready-to-run/ready-to-program” microprocessor core.
• Competitive pricing when compared with the alternative of purchasing and assembling
individual components.
• Easy C-language program development and debugging
• Program download utility (Rabbit Field Utility) and cloning board options for rapid
production loading of programs.
• Generous memory size allows large programs with tens of thousands of lines of code,
and substantial data storage.
• Integrated Ethernet port for network connectivity, with royalty-free TCP/IP software.
• Ideal for network-enabling security and access systems, home automation, HVAC
systems, and industrial controls
User’s Manual
5
1.4 Development and Evaluation Tools
1.4.1 RCM3305 Series Development Kit
The RCM3305 Series Development Kit contains the hardware you need to use your
RCM3309 or RCM3319 module.
• RCM3309 module.
• Prototyping Board.
• Universal AC adapter, 12 V DC, 1 A (includes Canada/Japan/U.S., Australia/N.Z., U.K.,
and European style plugs).
• USB programming cable with 10-pin header.
• Dynamic C CD-ROM, with complete product documentation on disk.
• Getting Started instructions.
• Accessory parts for use on the Prototyping Board.
• Screwdriver and Cat. 5 Ethernet cables.
• Rabbit 3000 Processor Easy Reference poster.
• Registration card.
DIAG
Programming
Cable
Universal
AC Adapter
with Plugs
Screwdriver
PROG
Ethernet
Cables
POWER
06
C7
R59
R51
R7
R2
JP3
R55
R56
R57
R58
C6
BT1
R16
R19
R18
C13
U5
/RES_OUT
RABBITNET
R3
R4
R5
R6
U6
C14
C15
07
SERI
AL
MODE FLAS
M H/
04 05
RP2
J11
R20
02 03
R17
C10
C11
C12
JP4
R8
R9
R10
R11
C9
PE7
PF6
U7
R63
R64
R65
R66
J2
JP1
PF4
R60 R61
C5
OUT
RP1
U4
R52 R53
R62
J3
JP2
C8
PF0_QD
U3
L293D
H-DRIVER
R14
R54
+DC
J1
GND
GND
VMA+ MDA1 MDA2 MDA3 MDA4 VMA
VMB MDB1 MDB2 MDB3 MDB4 VMB+
+DC
J4
GND
J5
DS1
QD2A QD2B QD1A QD1B GND
PB6
PB4
PB2
01
+5V
U2
C4
R13
J10
OUT 00
+5V
R67
R68
R69
R70
IN0
PB7
PB5
PB3
PB0
U1
R12
IN1
PE6
PF7
• RCM3309 module.
C3
L293D
H-DRIVER
PE3
PF5
• Prototyping Board.
C2
L1
PE5
IN2
PE1
The RCM3309/RCM3319 Development Kit contains the following items
PF0_CLKD
C1
D2
IN3
PG4
PG6
PE0
PE4
Development Kit Contents
D1
NC
+3.3 V
VRAM
SMODE1
/IORD
/IOWR
PG5
PG7
GND
J8
GND
GND
VBT
/RES
SM0
The RCM3309/RCM3319 RabbitCore modules feature built-in Ethernet, and onboard mass storage (serial
flash). These Getting Started instructions included with the Development Kit will help you get your
RCM3309 up and running so that you can run the sample programs to explore its capabilities and develop
your own applications.
J6
R1
RabbitCore RCM3309/RCM3319
J7
Accessory Parts for
Prototyping Board
R15
RCM3300
PROTOTYPING
BOARD
• Universal AC adapter, 12 V DC, 1 A (includes Canada/Japan/U.S., Australia/N.Z., U.K., and
European style plugs).
• USB programming cable with 10-pin header.
DS2
D4
D5
D6
DS3 DS4 DS5
J14
RxE
GND
TxF
RxF
RELA
Y
0.5 A RATED
@ 30
V
BD7
BD6
BD5
BD4
BD3
BD2
BD1
BD0
LCD
/CS
BA3
BA1
BA0
BA2
D6
D4
D2
D0
A1
A3
6
4
2
0
/RES
GND
+V
LED
LED
LED
LED
1
GND
GND
LED
D5
D3
D1
A0
A2
NC2
COM2
NO2
R44
5
3
D7
C27
R43
C28
C20
/CS
LED
+BK
LED
R41
3-6
SOT2
R38
NC1
K E Y PA D D I S P L AY B O A R D
C29
C30
Q5
R47
COM1
C18
C17
R33
R34
JP5
C26
LCD1JB
TxE
J17
D8
R35
NO1
C23
C24
K1
R45
C21
D7
DS6
J16
R42
U12
R46
J12
C19
DS
RELA7
Y
R50
Q6
CORE
R36
C22
R40
U11
U10
R48
R28
HO1
R27
S3
U9
J13
JB
HO2
R26
R49
S2
3-6
SOT2
LT
Q4
R32
Q3
Q2
GND
R25
J9
Getting Started
Instructions
UX2
SO20W
HO3
Q1
JA
R30
GND
STAT
R24
HO4
PA3
PA5
PA7
Rabbit, Dynamic C, and Digi are registered trademarks of Digi International Inc.
S1
RESET
R23
C25
R22
UX5
DX2
C16
R21
+3.3 V
R39 J15
LCD1JA
R37
PC0
PF1
PF3
PA1
R31
PA2
PA6
DX1
CX2
PC2
PC3
PC1
PF0
PF2
PA0
PA4
U8
PC4
R29
Insert the CD from the Development Kit in
your PC’s CD-ROM drive. If the installation
does not auto-start, run the setup.exe program in the root directory of the Dynamic C
CD. Install any optional Dynamic C modules
or packs after you install Dynamic C.
RX16
RX17
RX18
UX4
UX1
SO20W
PC6
PC7
PC5
Visit our online Rabbit store at www.rabbit.com/store/ for
the latest information on peripherals and accessories that
are available for the RCM3309/RCM3319 RabbitCore
modules.
RX13
RX14
RX15
CX1
PD4
PG2
PG0
PG1
GND
+3.3 V
PD6
PD2
PD3
PD5
PG3
Installing Dynamic C®
GND/EGND
LINK
ACT
PD7
• Screwdriver and Cat. 5 Ethernet cables.
• Getting Started instructions.
• Registration card.
GND
CORE MODULE
• A bag of accessory parts for use on the Prototyping Board.
• Rabbit 3000 Processor Easy Reference poster.
+5 V
+5 V
• Dynamic C® CD-ROM — with complete product documentation on disk.
LCD1JC
485+ GND 485
Prototyping Board
Figure 1. RCM3305 Series Development Kit
6
RabbitCore RCM3309/RCM3319
1.4.2 Software
The RCM3309 and the RCM3319 are programmed using version 9.60 of Rabbit’s
Dynamic C. A compatible version is included on the Development Kit CD-ROM. This
version of Dynamic C includes the popular µC/OS-II real-time operating system, point-topoint protocol (PPP), FAT file system, RabbitWeb, and other select libraries.
Rabbit also offers for purchase the Rabbit Embedded Security Pack featuring the Secure
Sockets Layer (SSL) and a specific Advanced Encryption Standard (AES) library. In addition to the Web-based technical support included at no extra charge, a one-year telephonebased technical support subscription is also available for purchase. Visit our Web site at
www.rabbit.com for further information and complete documentation, or contact your
Rabbit sales representative or authorized distributor.
1.4.3 Connectivity Interface Kits
Rabbit has available a Connector Adapter Board to allow you to use the the RCM3309/
RCM3319 with header sockets that have a 0.1" pitch.
• Connector Adapter Board (Part No. 151-0114)—allows you to plug the RCM3309/
RCM3319 whose headers have a 2 mm pitch into header sockets with a 0.1" pitch.
Visit our Web site at www.rabbit.com or contact your Rabbit sales representative or authorized distributor for further information.
1.4.4 Online Documentation
The online documentation is installed along with Dynamic C, and an icon for the documentation menu is placed on the workstation’s desktop. Double-click this icon to reach the
menu. If the icon is missing, use your browser to find and load default.htm in the docs
folder, found in the Dynamic C installation folder.
The latest versions of all documents are always available for free, unregistered download
from our Web sites as well.
User’s Manual
7
8
RabbitCore RCM3309/RCM3319
2. GETTING STARTED
This chapter explains how to set up and use the RCM3309/
RCM3319 modules with the accompanying Prototyping Board.
NOTE: It is assumed that you have a Development Kit. If you purchased an RCM3309 or
RCM3319 module by itself, you will have to adapt the information in this chapter and
elsewhere to your test and development setup.
2.1 Install Dynamic C
To develop and debug programs for the RCM3309/RCM3319 (and for all other Rabbit
hardware), you must install and use Dynamic C.
If you have not yet installed Dynamic C, do so now by inserting the Dynamic C CD from
the Development Kit in your PC’s CD-ROM drive. If autorun is enabled, the CD installation will begin automatically.
If autorun is disabled or the installation otherwise does not start, use the Windows
Start | Run menu or Windows Disk Explorer to launch setup.exe from the root folder
of the CD-ROM.
The installation program will guide you through the installation process. Most steps of the
process are self-explanatory.
Dynamic C uses a COM (serial) port to communicate with the target development system.
The installation allows you to choose the COM port that will be used. The default selection is COM1. Select any available USB port for Dynamic C’s use. This selection can be
changed later within Dynamic C.
NOTE: The installation utility does not check the selected COM port in any way. Specifying a port in use by another device (mouse, modem, etc.) may lead to a message such
as "could not open serial port" when Dynamic C is started.
Once your installation is complete, you will have up to three icons on your PC desktop.
One icon is for Dynamic C, one opens the documentation menu, and the third is for the
Rabbit Field Utility, a tool used to download precompiled software to a target system.
If you have purchased the optional Dynamic C Rabbit Embedded Security Pack, install it
after installing Dynamic C. You must install the Rabbit Embedded Security Pack in the
same directory where Dynamic C was installed.
User’s Manual
9
2.2 Hardware Connections
There are three steps to connecting the Prototyping Board for use with Dynamic C and the
sample programs:
1. Attach the RCM3309/RCM3319 module to the Prototyping Board.
2. Connect the programming cable between the RCM3309/RCM3319 and the workstation
PC.
3. Connect the power supply to the Prototyping Board.
2.2.1 Step 1 — Attach Module to Prototyping Board
C30
Y2
C31
R20
U7 R19
C34
L2
R13
R12
C26
C32
R14
C18
C13
C7
R62
R59
R51
R3
R4
R5
R6
R7
R2
R63
R64
R65
R66
R11
+5 V
Y1 C5
GND
GND
S3
CORE
DS2 DS3 DS4 DS5 DS6
J14
RELAY RATED
0.5 A @ 30 V
BD7
BD6
BD5
BD4
BD3
BD2
BD1
BD0
BA3
BA2
LCD
/CS
D2
D6
D0
D4
A1
GND
A0
LED6
D3
LED4
D1
LED2
A3
LED0
GND
A2
/RES
/CS
GND
D5
D7
C27
C28
R43
R44
C20
R45
R38
C29
K E Y PA D D I S P L AY B O A R D
C30
Q5
R47
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
D7
U12
D8
R35
JP5
C26
LED5
K1
U11
J17
R42
R48
D6
C22
C23
C24
C19
R37
HO1
HO2
HO3
HO4
JP1
J2
R49
S2
D5
R36
C25
D4
Q6
R32
J12
R50
U9
J13
JB
C21
Q4
GND
DS3
DS2
R34
R33
DS1
L1
JP2 JP3 JP4 JP5
R15
R27 R28
Q3
R30
Q1
C11
U2
R25 R26
Q2
LED3
+V
+BKLT
R40
R46
R33
R34
C18
DX2
UX2
SO20W
LCD1JA
U10
JA
Q1
R31
DS4
C10
R4
J1
R2
R21 R22 R23 R24
SOT23-6
UX5
CX2
J16
LED1
R5
R6
U1
JB
C16
SOT23-6
U3
U8
JA
+3.3 V
R39 J15
RX18
UX4
DX1
BA1
RX17
RX15
UX1
SO20W
R41
RX14
CX1
BA0
RX16
C17
C8
C9
U4
RX13
J9
S1
RESET
R54
C17
GND
R15
+5 V
R29
J3
C33
PA7
SERIAL FLASH/
R20 MODEM
C29
PA6
STAT
R19
R21
PA5
R55
R56
R57
R58
C13
R25 R26
R23
PA4
C14
C15
C10
C11
1
PA3
C12
JP4
C9
JP14
PA1
PA2
R18
R11
2
R16
6
Q2
R28
C46
R24 Y3
R18
RCM39XX
D1
R29 U10
PF3
PA0
R17
U9
C45
PF1
PF2
R10
C41
C42
PF4 PF6 PE7
JP1
PF0
JP2
PC0
JP3
+DC
J1
J2
J3
PC2
PC1
J11
BT1
+3.3 V
C1
PC4
PC3
R16
R1
PC6
PC5
RP2
R3
PC7
RP1
CORE MODULE
GND/EGND
C2
PG0
OUT 00 01 02 03 04 05 06 07
C12
C4
PG2
C3
PD4
C5
C6
R10
R9
PD2
PD5
PG1
R8
PD3
PG3
C7
R7
U5
PD6
R9
R14
RABBITNET
R8 U6 C6
U5
C14
PD7
U7
U3
L293D
H-DRIVER
C4
R60 R61
C16
R17 C19 C15
LINK
U2
R52 R53
OUT
C24 C20
C21
JP7
JP9
JP8
C27 C22
C23
JP10
ACT
PF0_QD
J10
U4
RCM3300
PROTOTYPING
BOARD
Do not press down
here.
DS1
+DC
GND
GND
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
C37
C36
C35
/RES_OUT
+5V QD2A QD2B QD1A QD1B GND J5
PB2
PB0
C8
+5V
PB4
PB3
R67
R68
R69
R70
R13
U1
C28 C25U
PB5
PF7
IN0
JP13
PB6
R12
C38
PF5
PB7
C44 C39
C40 R22
PE5
PE6
C43 U8
R30
PE3
PE4
L293D
H-DRIVER
R27
PE0
C47
PG7
IN1
L1
PG6
C3
JP11
PG4
PG5
C2
D2
/IORD
JP12
/IOWR
PE1
PF0_CLKD
C1
SMODE1
C49
C50
R32
C48
R31
R35
CE
SPD LNK FDX
ACT COL
BSY
SM0
IN2
VRAM
GND IN3
+3.3 V
VBT
/RES
RCM3309/
RCM3319
D1
NC
GND
J6
R1
J8
GND
J7
GND
Turn the RCM3309/RCM3319 module so that the Ethernet jack is facing the direction
shown in Figure 2 below. Align the pins from headers J61 and J62 on the bottom side of
the module into header sockets JA and JB on the Prototyping Board.
LCD1JB
LCD1JC
TxE RxE GND TxF RxF 485+ GND 485
CORE LED
Figure 2. Install the RCM3309/RCM3319 Module on the Prototyping Board
NOTE: It is important that you line up the pins on headers J61 and J62 of the RCM3309/
RCM3319 module exactly with the corresponding pins of header sockets JA and JB on
the Prototyping Board. The header pins may become bent or damaged if the pin alignment is offset, and the module will not work. Permanent electrical damage to the module may also result if a misaligned module is powered up.
Press the module’s pins firmly into the Prototyping Board header sockets—press down in
the area above the header pins using your thumbs or fingers over the connectors as shown
in Figure 2. Do not press down on the middle of the RCM3309/RCM3319 module to avoid
flexing the module, which could damage the module or the components on the module.
Should you need to remove the RCM3309/RCM3319 module, grasp it with your fingers along
the sides by the connectors and gently work the module up to pull the pins away from the sockets where they are installed. Do not remove the module by grasping it at the top and bottom.
10
RabbitCore RCM3309/RCM3319
2.2.2 Step 2 — Connect Programming Cable
The programming cable connects the RCM3309/RCM3319 to the PC running Dynamic C
to download programs and to monitor the RCM3309/RCM3319 module during debugging.
Connect the 10-pin connector of the programming cable labeled PROG to header J1 on
the RCM3309/RCM3319 as shown in Figure 3. There is a small dot on the circuit board
next to pin 1 of header J1. Be sure to orient the marked (usually red) edge of the cable
towards pin 1 of the connector. (Do not use the DIAG connector, which is used for a nonprogramming serial connection.)
1
AC adapter
2
Insert tab into slot
Assemble
AC Adapter
Press down on clip,
snap plug into place
C7
R59
R62
R51
R7
R2
R3
R4
R5
R6
R63
R64
R65
R66
R55
R56
R57
R58
R10
SERIAL FLASH/
R20 MODEM
C14
C15
R17
C10
C11
C12
JP4
C9
R18
C13
R15
R27
Q2
R28
JP14
C46
R24 Y3
C44 C39
1
R25 R26
R23
DS3
DS2
R34
Q1
R33
C40 R22
C43 U8
R30
C47
2
DS4
RCM39XX
D1
JP13
R32
C48
R31
SPD LNK FDX
ACT COL
R29 U10
CE
BSY
R16
R19
R11
RP2
RP1
J11
BT1
U5
U9
PF4 PF6 PE7
OUT 00 01 02 03 04 05 06 07
U4
R35
DS1
RCM3300
PROTOTYPING
BOARD
C8
C5
OUT
C45
/RES_OUT
R9
R14
RABBITNET
R8 U6 C6
C41
C42
PB2
PB0
U7
JP11
PB4
PB3
R60 R61
J10
JP12
PB6
PB5
R67
R68
R69
R70
R52 R53
U3
L293D
H-DRIVER
C4
R13
U1
C49
C50
PB7
PF7
U2
L293D
H-DRIVER
R12
PF5
PE6
JP1
PE5
L1
PF0_QD
JP2
PE3
PE4
C3
R54
J1
J2
PE0
PE1
J3
PG7
C2
D2
JP3
+DC
DS1
+DC
GND
GND
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
PG6
+5V QD2A QD2B QD1A QD1B GND J5
PG4
PG5
+5V
/IORD
/IOWR
PF0_CLKD
C1
SMODE1
IN0
VRAM
SM0
IN1
VBT
/RES
IN2
+3.3 V
GND IN3
D1
NC
GND
J6
R1
J8
GND
J7
GND
3-pin
power connector
C38
R21
R20
D5
R45
R38
Colored edge
PROG
J1
BD7
RELAY RATED
0.5 A @ 30 V
D2
D6
D0
D3
D4
A1
A0
D1
GND
A3
LED6
A2
LED4
D7
K E Y PA D D I S P L AY B O A R D
C28
C27
C29
C30
Q5
R44
To
PC USB port
R46
SOT23-6
D8
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
JP5
C26
BD6
BD5
BD4
BD3
BD2
BD1
BD0
BA3
LCD
/CS
BA2
BA1
BA0
LED2
GND
U12
R43
C17
C20
+BKLT
U11
J17
R42
R47
R48
C25
HO2
R32
HO3
R30
C21
JP1
R15
HO1
C11
C10
JP2 JP3 JP4 JP5
U2
R31
C23
C24
C19
K1
R35
R36
C22
DIAG
L1
R4
J1
R2
HO4
R33
R34
PROG
R5
R6
GND
R40
R37
U3
R29
C18
Y1 C5
C8
C9
U4
DS2 DS3 DS4 DS5 DS6
J14
LED0
+V
SOT23-6
C18
C13
R11
D7
U1
J3
C33
CORE
D6
GND
C26
C32
R14
J2
S3
D5
/RES
R13
R12
R49
LCD1JA
U10
U9
/CS
6
C17
D4
UX2
SO20W
J13
LED5
L2
R16
J12
R50
Q6
S2
JB
LED3
C31
R27 R28
DX2
J16
LED1
C34
C30
R25 R26
J9
S1
RESET
Y2
GND
C29
PA7
PA6
STAT
R18
Q4
C1
Q3
R1
Q2
UX5
CX2
R3
Q1
DX1
+3.3 V
R39 J15
RX18
UX4
UX1
SO20W
C12
JA
RX16
RX17
RX15
C16
R21 R22 R23 R24
C2
PA5
RX13
RX14
C6
PA3
PA4
C24 C20
C21
PA1
PA2
C16
C4
PF3
PA0
GND
+3.3 V
CX1
C3
PF2
U8
C7
R7
PF1
C28 C25U
PC0
PF0
R10
PC2
PC1
R9
PC4
PC3
R8
PC6
PC5
U5
PC7
GND
C14
PG0
R17 C19 C15
PG2
JP7
PD4
PG1
JP9
PD5
PG3
JP8
PD2
C27 C22
C23
PD6
PD3
+5 V
+5 V
R41
U7 R19
C37
C36
PD7
GND/EGND
JP10
LINK
C35
CORE MODULE
ACT
LCD1JB
LCD1JC
TxE RxE GND TxF RxF 485+ GND 485
Programming Cable
Figure 3. Connect Programming Cable and Power Supply
Connect the other end of the programming cable to an available USB port on your PC or
workstation. Your PC should recognize the new USB hardware, and the LEDs in the
shrink-wrapped area of the USB programming cable will flash.
User’s Manual
11
2.2.3 Step 3 — Connect Power
When all other connections have been made, you can connect power to the Prototyping
Board.
First, prepare the AC adapter for the country where it will be used by selecting the plug.
The RCM3909/RCM3319 Development Kit presently includes Canada/Japan/U.S., Australia/N.Z., U.K., and European style plugs. Snap in the top of the plug assembly into the
slot at the top of the AC adapter as shown in Figure 3, then press down on the springloaded clip below the plug assembly to allow the plug assembly to click into place.
Connect the AC adapter to 3-pin header J2 on the Prototyping Board as shown in Figure 3.
Plug in the AC adapter. The red CORE LED on the Prototyping Board should light up. The
RCM3309/RCM3319 and the Prototyping Board are now ready to be used.
NOTE: A RESET button is provided on the Prototyping Board to allow a hardware reset
without disconnecting power.
12
RabbitCore RCM3309/RCM3319
2.3 Starting Dynamic C
Once the RCM3309/RCM3319 is connected as described in the preceding pages, start
Dynamic C by double-clicking on the Dynamic C icon on your desktop or in your Start
menu. Select Code and BIOS in Flash, Run in RAM on the “Compiler” tab in the
Dynamic C Options > Project Options menu. Then click on the “Communications” tab
and verify that Use USB to Serial Converter is selected to support the USB programming cable. Click OK.
2.4 Run a Sample Program
Use the File menu to open the sample program PONG.C, which is in the Dynamic C
SAMPLES folder. Press function key F9 to compile and run the program. The STDIO
window will open on your PC and will display a small square bouncing around in a box.
This program shows that the CPU is working. The sample program described in
Section 6.5, “Run the PINGME.C Sample Program,” tests the TCP/IP portion of the board.
2.4.1 Troubleshooting
If Dynamic C cannot find the target system (error message "No Rabbit Processor
Detected."):
• Check that the RCM3309/RCM3319 is powered correctly — the red core LED on the
Prototyping Board should be lit when the RCM3309/RCM3319 is mounted on the Prototyping
Board and the AC adapter is plugged in.
• Check both ends of the programming cable to ensure that they are firmly plugged into
the PC and the PROG connector, not the DIAG connector, is plugged in to the programming port on the RCM3309/RCM3319 with the marked (colored) edge of the programming cable towards pin 1 of the programming header.
• Ensure that the RCM3309/RCM3319 module is firmly and correctly installed in its
connectors on the Prototyping Board.
• Dynamic C uses the USB port specified during installation. Select a different COM
port within Dynamic C. From the Options menu, select Project Options, then select
Communications. Select another USB COM port from the list, then click OK. Press
to force Dynamic C to recompile the BIOS. If Dynamic C still reports it is
unable to locate the target system, repeat the above steps until you locate the USB
COM port used by the RCM3309/RCM3319 programming cable.
• If you get an error message when you plugged the programming cable into a USB port,
you will have to install USB drivers. Drivers for Windows XP are available in the
Dynamic C Drivers\Rabbit USB Programming Cable\WinXP_2K folder —
double-click DPInst.exe to install the USB drivers. Drivers for other operating systems are available online at www.ftdichip.com/Drivers/VCP.htm.
User’s Manual
13
If Dynamic C appears to compile the BIOS successfully, but you then receive a communication error message when you compile and load a sample program, it is possible that your
PC cannot handle the higher program-loading baud rate. Try changing the maximum
download rate to a slower baud rate as follows.
• Locate the Serial Options dialog on the “Communications” tab in the Dynamic C
Options > Project Options menu. Select a slower Max download baud rate. Click OK
to save.
If a program compiles and loads, but then loses target communication before you can
begin debugging, it is possible that your PC cannot handle the default debugging baud
rate. Try lowering the debugging baud rate as follows.
• Locate the Serial Options dialog in the Dynamic C Options > Project Options >
Communications menu. Choose a lower debug baud rate. Click OK to save.
Press to force Dynamic C to recompile the BIOS. The LEDs on the USB programming cable will blink and you should receive a Bios compiled successfully
message.
2.5 Where Do I Go From Here?
If the sample program ran fine, you are now ready to go on to other sample programs and to
develop your own applications. The source code for the sample programs is provided to allow
you to modify them for your own use. The RCM3309/RCM3319 User’s Manual also
provides complete hardware reference information and describes the software function calls
for the RCM3309 and the RCM3319, the Prototyping Board, and the optional LCD/keypad
module.
For advanced development topics, refer to the Dynamic C User’s Manual and the
Dynamic C TCP/IP User’s Manual, also in the online documentation set.
2.5.1 Technical Support
NOTE: If you purchased your RCM3309/RCM3319 through a distributor or through a
Rabbit partner, contact the distributor or partner first for technical support.
If there are any problems at this point:
• Use the Dynamic C Help menu to get further assistance with Dynamic C.
• Check the Rabbit Technical Bulletin Board and forums at www.rabbit.com/support/bb/
and at www.rabbit.com/forums/.
• Use the Technical Support e-mail form at www.rabbit.com/support/.
14
RabbitCore RCM3309/RCM3319
3. RUNNING SAMPLE PROGRAMS
To develop and debug programs for the RCM3309/RCM3319
(and for all other Rabbit hardware), you must install and use
Dynamic C.
3.1 Introduction
To help familiarize you with the RCM3309 and RCM3319 modules, Dynamic C includes
several sample programs. Loading, executing and studying these programs will give you a
solid hands-on overview of the RCM3309/RCM3319’s capabilities, as well as a quick
start using Dynamic C as an application development tool.
NOTE: The sample programs assume that you have at least an elementary grasp of the C
programming language. If you do not, see the introductory pages of the Dynamic C
User’s Manual for a suggested reading list.
In order to run the sample programs discussed in this chapter and elsewhere in this manual,
1. Your RCM3309/RCM3319 must be plugged in to the Prototyping Board as described
in Chapter 2, “Getting Started.”
2. Dynamic C must be installed and running on your PC.
3. The programming cable must connect the programming header on the RCM3309/
RCM3319 to your PC.
4. Power must be applied to the RCM3309/RCM3319 through the Prototyping Board.
Refer to Chapter 2, “Getting Started,” if you need further information on these steps.
To run a sample program, open it with the File menu, then compile and run it by pressing
F9.
Complete information on Dynamic C is provided in the Dynamic C User’s Manual.
User’s Manual
15
3.2 Sample Programs
Of the many sample programs included with Dynamic C, several are specific to the
RCM3309 and the RCM3319. Sample programs illustrating the general operation of the
RCM3309/RCM3319, serial communication, and the serial flash are provided in the
SAMPLES\RCM3300 folder. Each sample program has comments that describe the purpose
and function of the program. Follow the instructions at the beginning of the sample program. Note that the RCM3309/RCM3319 must be installed on the Prototyping Board
when using the sample programs described in this chapter.
• CONTROLLED.c—Demonstrates use of the digital outputs by having you turn the
LEDs on the Prototyping Board on or off from the STDIO window on your PC.
Once you compile and run CONTROLLED.C, the following display will appear in the
Dynamic C STDIO window.
Press “2” or “3” or “4”or “5”on your keyboard to select LED DS3 or DS4 or DS5 or
DS6 on the Prototyping Board. Then follow the prompt in the Dynamic C STDIO window to turn the LED on or off.
• FLASHLED.c—Demonstrates assembly-language program by flashing the USR LED
on the RCM3309/RCM3319 and LEDs DS3, DS4, DS5, and DS6 on the Prototyping
Board.
• SWRELAY.c—Demonstrates the relay-switching function call using the relay installed
on the Prototyping Board through screw-terminal header J17.
• TOGGLESWITCH.c—Uses costatements (cooperative multitasking) to detect switches
S2 and S3 using debouncing. The corresponding LEDs (DS3 and DS4) will turn on or
off.
Once you have loaded and executed these five programs and have an understanding of
how Dynamic C and the RCM3309/RCM3319 modules interact, you can move on and try
the other sample programs, or begin building your own.
16
RabbitCore RCM3309/RCM3319
3.2.1 Use of Serial Flash
3.2.1.1 Onboard Serial Flash
The following sample programs can be found in the SAMPLES\RCM3300\SerialFlash
folder.
• SFLASH_INSPECT.c—This program is a handy utility for inspecting the contents of a
serial flash chip. When the sample program starts running, it attempts to initialize a
serial flash chip on Serial Port B. Once a serial flash chip is found, the user can perform
two different commands to either print out the contents of a specified page or clear (set
to zero) all the bytes in a specified page.
• SFLASH_LOG.c—This program runs a simple Web server and stores a log of hits in
the serial flash. This log can be viewed and cleared from a browser.
3.2.1.2 SF1000 Serial Flash Card
The following sample program can be found in the SAMPLES\RCM3300\SF1000 folder.
• SERFLASHTEST.c—An optional SF1000 Serial Flash card is required to run this demonstration. Install the Serial Flash card into socket J11 on the Prototyping Board. This
sample program demonstrates how to read and write from/to the Serial Flash card.
3.2.2 Serial Communication
The following sample programs can be found in the SAMPLES\RCM3300\SERIAL folder.
• FLOWCONTROL.C—This program demonstrates hardware flow control by configuring
Serial Port F for CTS/RTS with serial data coming from TxE (Serial Port E) at 115,200
bps. One character at a time is received and is displayed in the STDIO window.
To set up the Prototyping Board, you will need to tie
TxE and RxE together on the RS-232 header at J14,
and you will also tie TxF and RxF together as shown in
the diagram.
J14
TxE RxE GND TxF RxF 485+ GND 485
A repeating triangular pattern should print out in the
STDIO window. The program will periodically switch flow control on or off to demonstrate the effect of no flow control.
• PARITY.C—This program demonstrates the use of parity modes by repeatedly sending
byte values 0–127 from Serial Port E to Serial Port F. The program will switch between
generating parity or not on Serial Port E. Serial Port F will always be checking parity,
so parity errors should occur during every other sequence.
To set up the Prototyping Board, you will need to tie
TxE and RxF together on the RS-232 header at J14 as
shown in the diagram.
The Dynamic C STDIO window will display the error
sequence.
User’s Manual
J14
TxE RxE GND TxF RxF 485+ GND 485
17
• SIMPLE3WIRE.C—This program demonstrates basic RS-232 serial communication.
Lower case characters are sent by TxE, and are received by RxF. The characters are
converted to upper case and are sent out by TxF, are received by RxE, and are displayed
in the Dynamic C STDIO window.
To set up the Prototyping Board, you will need to tie
TxE and RxF together on the RS-232 header at J14, and
you will also tie RxE and TxF together as shown in the
diagram.
J14
TxE RxE GND TxF RxF 485+ GND 485
• SIMPLE5WIRE.C—This program demonstrates 5-wire RS-232 serial communication
with flow control on Serial Port F and data flow on Serial Port E.
To set up the Prototyping Board, you will need to tie
TxE and RxE together on the RS-232 header at J14,
and you will also tie TxF and RxF together as shown in
the diagram.
J14
TxE RxE GND TxF RxF 485+ GND 485
Once you have compiled and run this program, you can
test flow control by disconnecting TxF from RxF while the program is running. Characters will no longer appear in the STDIO window, and will display again once TxF is
connected back to RxF.
• SWITCHCHAR.C—This program transmits and then receives an ASCII string on Serial
Ports E and F. It also displays the serial data received from both ports in the STDIO
window.
To set up the Prototyping Board, you will need to tie
TxE and RxF together on the RS-232 header at J14, and
you will also tie RxE and TxF together as shown in the
diagram.
J14
TxE RxE GND TxF RxF 485+ GND 485
Once you have compiled and run this program, press
and release S2 and S3 on the Prototyping Board. The data sent between the serial ports
will be displayed in the STDIO window.
Two sample programs, SIMPLE485MASTER.C and SIMPLE485SLAVE.C, are available
to illustrate RS-485 master/slave communication. To run these sample programs, you will
need a second Rabbit-based system with RS-485—another Rabbit single-board computer
or RabbitCore module may be used as long as you use the master or slave sample program
associated with that board.
Before running either of these sample programs on the RCM3309/RCM3319 assembly,
make sure pins 1–2 and pins 5–6 are jumpered together on header JP5 to use the RS-485
bias and termination resistors. The sample programs use Serial Port C as the RS-485 serial
port, and they use PD7 to enable/disable the RS-485 transmitter.
18
RabbitCore RCM3309/RCM3319
The RS-485 connections between the slave and master devices are as follows.
•
RS485+ to RS485+
•
RS485– to RS485–
•
GND to GND
• SIMPLE485MASTER.C—This program demonstrates a simple RS-485 transmission of
lower case letters to a slave. The slave will send back converted upper case letters back
to the master and display them in the STDIO window. Use SIMPLE485SLAVE.C to
program the slave.
• SIMPLE485SLAVE.C—This program demonstrates a simple RS-485 transmission of
lower case letters to a master. The slave will send back converted upper case letters
back to the master and display them in the STDIO window. Use SIMPLE485MASTER.C
to program the master.
3.2.3 Real-Time Clock
If you plan to use the real-time clock functionality in your application, you will need to set
the real-time clock. Set the real-time clock using the SETRTCKB.C sample program from
the Dynamic C SAMPLES\RTCLOCK folder, using the onscreen prompts. The RTC_
TEST.C sample program in the Dynamic C SAMPLES\RTCLOCK folder provides additional examples of how to read and set the real-time clock.
3.2.4 RabbitNet
Sample programs are available for each RabbitNet peripheral card, and can be found in the
Dynamic C SAMPLES\RabbitNet folder. When you run any of these sample programs
in conjunction with the RCM3309/RCM3319 and the Prototyping Board, you need to add
the line
#use rcm33xx.lib
at the beginning of the sample program.
TIP: You need to add #use rcm33xx.lib at the beginning of any sample program
that is not in the Dynamic C SAMPLES\RCM3300 folder.
3.2.5 Other Sample Programs
Section 6.6 describes the TCP/IP sample programs, and Appendix C.7 provides sample
programs for the optional LCD/keypad module that can be installed on the Prototyping
Board.
User’s Manual
19
20
RabbitCore RCM3309/RCM3319
4. HARDWARE REFERENCE
Chapter 4 describes the hardware components and principal hardware
subsystems of the RCM3309/RCM3319 modules. Appendix A,
“RCM3309/RCM3319 Specifications,” provides complete physical
and electrical specifications.
Figure 4 shows the Rabbit-based subsystems designed into the RCM3309/RCM3319.
Ethernet
Fast SRAM
(program)
Data
SRAM
32 kHz 44.2 MHz
osc
osc
RABBIT ®
3000
Program
Flash
Serial
Flash
Battery-Backup
Circuit
RabbitCore Module
Customer-specific
applications
CMOS-level signals
Level
converter
RS-232, RS-485
serial communication
drivers on motherboard
Customer-supplied
external 3 V battery
Figure 4. RCM3309/RCM3319 Subsystems
User’s Manual
21
4.1 RCM3309/RCM3319 Digital Inputs and Outputs
Figure 5 shows the RCM3309/RCM3319 pinouts for headers J3 and J4.
J61
GND
PA7
PA5
PA3
PA1
PF3
PF1
PC0
PC2
n.c./PC4
PC6-TxA
PG0
PG2
PD4
PD2/TPO
PD6/TPI
LINK/n.c.
J62
STATUS
PA6
PA4
PA2
PA0
PF2
PF0
PC1
PC3
n.c./PC5
PC7-RxA
PG1
PG3
PD5
PD3/TPO+
PD7/TPI+
ACT/n.c.
n.c./PB0
PB3
PB5
PB7
PF5
PF7
PE6
PE4
PE1
PG7
PG5
/IOWR
SMODE0
/RESET_IN
VBAT_EXT
GND
GND
/RES
PB2
PB4
PB6
PF4
PF6
PE7
PE5
PE3
PE0
PG6
PG4
/IORD
SMODE1
VRAM
+3.3 VIN
n.c.
n.c. = not connected
Note: These pinouts are as seen on
the Bottom Side of the module.
Figure 5. RCM3309/RCM3319 Pinouts
The pinouts for the RCM3000, RCM3100, RCM3200, RCM3300/RCM3305/RCM3309/
RCM3319, RCM3360/RCM3370, RCM3365/RCM3375, and RCM3900 are almost compatible, except signals PB0, PC4, and PC5. PB0, PC4, and PC5 are used for the SPI interface to the
serial flash on the RCM3305/RCM3309/RCM3315/RCM3319. Visit the Web site for further
information.
Headers J61 and J62 are standard 2 × 34 headers with a nominal 2 mm pitch. An RJ-45
Ethernet port is also included with the RCM3309/RCM3319.
Pins 29–32 on header J61 are configured using 0 Ω resistors at locations JP9, JP10, JP7,
and JP8 to be PD2, PD3, PD6, and PD7 respectively. They may also be reconfigured to
carry the Ethernet signals TPI+, TPI–, TPO+, and TPO–, but this capability is reserved for
future use.
Pins 33 and 34 on header J62 are wired to carry the LINK and ACT signals that illuminate
the corresponding LEDs on the RCM3309/RCM3319 module. These pins may be “configured” to carry PD0 and PD1, an option that is reserved for future use.
See Appendix A.5 for more information about the locations of these headers.
22
RabbitCore RCM3309/RCM3319
Figure 6 shows the use of the Rabbit 3000 microprocessor ports in the RCM3309/
RCM3319 modules.
PC0, PC2
PC1, PC3
PG2PG3
PG6PG7
PB1, PC6, STATUS
PC7, /RESET,
SMODE0, SMODE1
4 Ethernet signals
PA0PA7
PB2PB7
PD2PD7
Port A
Port B
Port D
Port C
(Serial Ports C & D)
Port G
RABBIT
®
(+Ethernet Port)
Port E
PE0PE1,
PE3PE7
Port F
PF0PF7
Port G
PG0PG1,
PG4PG5
3000
(Serial Ports E & F)
Programming
Port
(Serial Port A)
Ethernet
Port
RAM
Real-Time Clock
Watchdog
11 Timers
Slave Port
Clock Doubler
(+Serial Ports)
Misc. I/O
Backup Battery
Support
/RES
/RES
/IORD
/IOWR
Flash
Figure 6. Use of Rabbit 3000 Ports
The ports on the Rabbit 3000 microprocessor used in the RCM3309/RCM3319 are configurable, and so the factory defaults can be reconfigured. Table 2 lists the Rabbit 3000
factory defaults and the alternate configurations.
User’s Manual
23
Table 2. RCM3309/RCM3319 Pinout Configurations
Pin
Pin Name
1
GND
2
STATUS
Default Use
Alternate Use
Output (Status)
Output
3–10
PA[7:0]
Parallel I/O
External data bus
(ID0–ID7)
Slave port data bus
(SD0–SD7)
11
PF3
Input/Output
QD2A
12
PF2
Input/Output
QD2B
13
PF1
Input/Output
QD1A
CLKC
14
PF0
Input/Output
QD1B
CLKD
15
PC0
Output
TXD
16
PC1
Input
RXD
17
PC2
Output
TXC
18
PC3
Input
RXC
19
PC4
Output
TXB
Notes
External Data Bus
Serial Port D
Header J61
Serial Port C
Serial Port B
RCM3309/RCM3319—
Not Connected (used for
onboard serial flash)
20
PC5
Input
RXB
21
PC6
Output
TXA
22
PC7
Input
RXA
Serial Port A
(programming port)
23
PG0
Input/Output
TCLKF
Serial Clock F output
24
PG1
Input/Output
RCLKF
Serial Clock F input
25
PG2
Input/Output
TXF
26
PG3
Input/Output
RXF
27
PD4
Input/Output
ATXB
28
PD5
Input/Output
ARXB
29
PD2/TPO–
Input/Output
TPOUT– *
30
PD3/TPO+
Input/Output
TPOUT+ *
31
PD6/TPI–
Input/Output
TPIN– *
32
PD7/TPI+
Input/Output
TPIN+ *
33
LINK
Output
34
ACT
Output
Serial Port F
*
24
Optional Ethernet
transmit port
Optional Ethernet
receive port
Max. sinking current
draw 1 mA (see Note 1)
Pins 29–32 are configured with 0 Ω surface-mount resistors at JP4, JP5, JP7, and JP8.
RabbitCore RCM3309/RCM3319
Table 2. RCM3309/RCM3319 Pinout Configurations (continued)
Header J62
Pin
Pin Name
Default Use
Alternate Use
Notes
Reset output from Reset
Generator
1
/RES
Reset output
2
PB0
Input/Output
CLKB
RCM3309/RCM3319—
Not Connected (used for
onboard serial flash)
3
PB2
Input/Output
IA0
/SWR
External Address 0
Slave port write
4
PB3
Input/Output
IA1
/SRD
External Address 1
Slave port read
5
PB4
Input/Output
IA2
SA0
External Address 2
Slave port Address 0
6
PB5
Input/Output
IA3
SA1
External Address 3
Slave port Address 1
7
PB6
Input/Output
IA4
External Address 4
8
PB7
Input/Output
IA5
/SLAVEATTN
External Address 5
Slave Attention
9
PF4
Input/Output
AQD1B
PWM0
10
PF5
Input/Output
AQD1A
PWM1
11
PF6
Input/Output
AQD2B
PWM2
12
PF7
Input/Output
AQD2A
PWM3
13
PE7
Input/Output
I7
/SCS
I/O Strobe 7
Slave Port Chip Select
14
PE6
Input/Output
I6
I/O Strobe 6
15
PE5
Input/Output
I5
INT1B
I/O Strobe 5
Interrupt 1B
16
PE4
Input/Output
I4
INT0B
I/O Strobe 4
Interrupt 0B
17
PE3
Input/Output
I3
I/O Strobe 3
18
PE1
Input/Output
I1
INT1A
I/O Strobe 1
Interrupt 1A
19
PE0
Input/Output
I0
INT0A
I/O Strobe 0
Interrupt 0A
User’s Manual
25
Table 2. RCM3309/RCM3319 Pinout Configurations (continued)
Pin
Pin Name
Default Use
Alternate Use
Notes
20
PG7
Input/Output
RXE
21
PG6
Input/Output
TXE
22
PG5
Input/Output
RCLKE
Serial Clock E input
23
PG4
Input/Output
TCLKE
Serial Clock E ouput
24
/IOWR
Output
External write strobe
25
/IORD
Output
External read strobe
Header J62
Serial Port E
26–27
SMODE0,
SMODE1
(0,0)—start executing at address zero
(0,1)—cold boot from slave port
(1,0)—cold boot from clocked Serial Port A
Also connected to
programming cable
SMODE0 =1, SMODE1 = 1
Cold boot from asynchronous Serial Port A at
2400 bps (programming cable connected)
28
/RESET_IN
Input
Input to Reset Generator
29
VRAM
Output
See Notes below table
30
VBAT_EXT
3 V battery Input
Minimum battery
voltage 2.85 V
31
+3.3 VIN
Power Input
3.15–3.45 V DC
32
GND
33
n.c.
34
GND
Reserved for future use
Notes
1. When using pins 33–34 on header J3 to drive LEDs, these pins can handle a sinking
current of up to 8 mA.
2. The VRAM voltage is temperature-dependent. If the VRAM voltage drops below about
1.2 V to 1.5 V, the contents of the battery-backed SRAM may be lost. If VRAM drops
below 1.0 V, the 32 kHz oscillator could stop running. Pay careful attention to this voltage if you draw any current from this pin.
26
RabbitCore RCM3309/RCM3319
4.1.1 Memory I/O Interface
The Rabbit 3000 address lines (A0–A18) and all the data lines (D0–D7) are routed
internally to the onboard flash memory and SRAM chips. I/O write (/IOWR) and I/O read
(/IORD) are available for interfacing to external devices.
Parallel Port A can also be used as an external I/O data bus to isolate external I/O from the
main data bus. Parallel Port B pins PB2–PB5 and PB7 can also be used as an auxiliary
address bus.
When using the auxiliary I/O bus for a digital output or the LCD/keypad module on the
Prototyping Board, or for any other reason, you must add the following line at the beginning of your program.
#define PORTA_AUX_IO
// required to enable auxiliary I/O bus
4.1.2 LEDs
The RCM3309/RCM3319 has three Ethernet status LEDs located beside the RJ-45
Ethernet jack—these are discussed in Section 4.2.
Addiitionally, there is one dual LED DS4. PD1 on the Rabbit 3000’s Parallel Port D is
used to enable the serial flash, and is connected to the green CE LED at DS4, which blinks
when data are being written to or read from the serial flash. The red BSY LED at DS4 is a
user-programmable LED, and is controlled by PD0. The CONTROLLED.C and FLASHLED.C
sample programs in the Dynamic C SAMPLES\RCM3300 folder show how to set up and
use this user-programmable LED.
4.1.3 Other Inputs and Outputs
The status, /RESET_IN, SMODE0, and SMODE1 I/O are normally associated with the
programming port. Since the status pin is not used by the system once a program has been
downloaded and is running, the status pin can then be used as a general-purpose CMOS
output. The programming port is described in more detail in Section 4.2.3.
/RES is an output from the reset circuitry that can be used to reset external peripheral
devices.
User’s Manual
27
4.2 Serial Communication
The RCM3309/RCM3319 does not have any serial protocol-level transceivers directly on
the board. However, a serial interface may be incorporated into the board the RCM3309/
RCM3319 is mounted on. For example, the Prototyping Board has RS-232 and RS-485
transceiver chips.
4.2.1 Serial Ports
There are six serial ports designated as Serial Ports A, B, C, D, E, and F. All six serial
ports can operate in an asynchronous mode up to the baud rate of the system clock divided
by 8. An asynchronous port can handle 7 or 8 data bits. A 9th bit address scheme, where
an additional bit is sent to mark the first byte of a message, is also supported.
Serial Port A is normally used as a programming port, but may be used either as an asynchronous or as a clocked serial port once the RCM3309/RCM3319 has been programmed
and is operating in the Run Mode.
Serial Port B is used to communicate with the serial flash on the RCM3309/RCM3319 and
is not available for other use.
Serial Ports C and D can also be operated in the clocked serial mode. In this mode, a clock
line synchronously clocks the data in or out. Either of the two communicating devices can
supply the clock.
Serial Ports E and F can also be configured as HDLC serial ports. The IrDA protocol is
also supported in SDLC format by these two ports.
28
RabbitCore RCM3309/RCM3319
4.2.2 Ethernet Port
Figure 7 shows the pinout for the RJ-45 Ethernet port (J3). Note that some Ethernet connectors are numbered in reverse to the order used here.
ETHERNET
1
8
1.
2.
3.
6.
RJ-45 Plug
E_Tx+
E_Tx
E_Rx+
E_Rx
RJ-45 Jack
Figure 7. RJ-45 Ethernet Port Pinout
Three LEDs are placed next to the RJ-45 Ethernet
jack, one to indicate Ethernet link/activity (LNK/
ACT), one to indicate when the RCM3309/RCM3319
is connected to a functioning 100Base-T network
(SPD), and one (FDX/COL) to indicate whether the
current connection is in full-duplex mode (steady
on) or that a half-duplex connection is experiencing
collisions (blinks).
RJ-45 Ethernet Jack
L1
Board
Ground
Chassis
Ground
Figure 8. Ferrite Bead Isolation
The transformer/connector assembly ground is connected to the RCM3209 printed circuit board digital
ground via a ferrite bead, L1, as shown in Figure 8.
The RJ-45 connector is shielded to minimize EMI effects to/from the Ethernet signals.
The Ethernet chip supports auto MDI/MDIX on the Ethernet port to choose the Ethernet
interface automatically based on whether a crossover cable or a straight-through cable is
used in a particular setup. The Ethernet chip may spike the current draw by up to 200 mA
while it is searching to determine the type of Ethernet cable. This search is repeated every
second if no Ethernet cable is detected. If you do not plan to connect an Ethernet cable,
use the Dynamic C pd_powerdown() function call to turn off the Ethernet chip. The
pd_powerup() function call is available to turn the Ethernet chip back on at a later time.
These function calls are described in the Dynamic C TCP/IP User’s Manual, Volume 1.
User’s Manual
29
4.2.3 Serial Programming Port
The RCM3309/RCM3319 is programmed either through the serial programming port,
which is accessed using header J1, or through the Ethernet jack. The RabbitLink may be
used to provide a serial connection via the RabbitLink’s Ethernet jack. The programming
port uses the Rabbit 3000’s Serial Port A for communication; Serial Port A is not used
when programming is done over an Ethernet connection via the Dynamic C download
manager or the remote application update. Dynamic C uses the programming port to
download and debug programs.
The programming port is also used for the following operations.
• Cold-boot the Rabbit 3000 on the RCM3309/RCM3319 after a reset.
• Remotely download and debug a program over an Ethernet connection using the
RabbitLink EG2110.
• Fast copy designated portions of flash memory from one Rabbit-based board (the
master) to another (the slave) using the Rabbit Cloning Board.
In addition to Serial Port A, the Rabbit 3000 startup-mode (SMODE0, SMODE1), status,
and reset pins are available on the programming port.
The two startup mode pins determine what happens after a reset—the Rabbit 3000 is
either cold-booted or the program begins executing at address 0x0000.
The status pin is used by Dynamic C to determine whether a Rabbit microprocessor is
present. The status output has three different programmable functions:
1. It can be driven low on the first op code fetch cycle.
2. It can be driven low during an interrupt acknowledge cycle.
3. It can also serve as a general-purpose CMOS output.
The /RESET_IN pin is an external input that is used to reset the Rabbit 3000 and the
RCM3309/RCM3319 onboard peripheral circuits. The serial programming port can be
used to force a hard reset on the RCM3309/RCM3319 by asserting the /RESET_IN signal.
Alternate Uses of the Programming Port
All three clocked Serial Port A signals are available as
• a synchronous serial port
• an asynchronous serial port, with the clock line usable as a general CMOS I/O pin
The programming port may also be used as a serial port once the application is running.
The SMODE pins may then be used as inputs and the status pin may be used as an output.
Refer to the Rabbit 3000 Microprocessor User’s Manual for more information.
30
RabbitCore RCM3309/RCM3319
4.3 Programming Cable
The programming cable is used to connect the programming port of the RCM3309/
RCM3319 to a PC USB COM port. The programming cable converts the voltage levels
used by the PC USB port to the CMOS voltage levels used by the Rabbit 3000.
When the PROG connector on the programming cable is connected to the RCM3309/
RCM3319 programming port, programs can be downloaded and debugged over the serial
interface.
The DIAG connector of the programming cable may be used on header J1 of the RCM3309/
RCM3319 with the RCM3309/RCM3319 operating in the Run Mode. This allows the
programming port to be used as a regular serial port.
4.3.1 Changing Between Program Mode and Run Mode
C7
R62
R3
R4
R5
R6
R7
R2
SERIAL FLASH/
MODEM
R20
R19
RELAY RATED
0.5 A @ 30 V
BD7
BD6
BD5
BD4
BD3
BA3
BD2
GND
A3
A1
D0
D2
GND
A2
A0
D1
D3
D6
LED6
GND
D4
LED4
LED5
K E Y PA D D I S P L AY B O A R D
Colored edge
D5
D7
R44
C28
R43
C27
C30
R46
C29
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
R38
JP2 JP3 JP4 JP5
R4
R2
U1
J1
U2
R15
LCD1JB
TxE RxE GND TxF RxF 485+ GND 485
BD1
BD0
BA2
BA1
BA0
LCD
/CS
LED2
+V
+BKLT
D8
To
PC USB port
Q5
R47
R48
R5
R6
C21
U12
R45
U3
HO1
C20
C11
C10
HO2
R41
C8
C9
U4
JP1
J2
R32
SOT23-6
Y1 C5
L1
R31
LED0
C18
C13
HO3
/RES
C17
R11
J3
C33
HO4
/CS
C26
C32
R14
GND
LED3
R13
R12
R30
U11
J17
R42
K1
R35
JP5
C26
LED1
L2
R16
U6
R19
C31
R29
SOT23-6
U7
C34
C30
Y2
DS2 DS3 DS4 DS5 DS6
J14
C19
R37
DS1
R21
C29
CORE
D7
R40
DIAG
DS2
R33
S3
D6
C18
DS3
R34
S2
D5
J16
LCD1JA
U10
R36
C22
C23
C24
C17
Q1
R49
R33
PROG
R34
Q2
D4
Q6
C1
R50
U9
R1
J12
J13
JB
C25
DS4
RCM39XX
R20
R18
UX2
SO20W
R3
J9
S1
RESET
C6
R27 R28
Q4
UX5
DX2
+3.3 V
R39 J15
RX18
UX4
DX1
C12
R25 R26
Q3
RX17
RX15
C16
GND
Q2
C2
PA7
C7
R7
PA6
STAT
JA
Q1
RX16
RX14
C24 C20
C21
PA5
C28 C25
PA4
R21 R22 R23 R24
C4
PA3
C3
PA1
PA2
RX13
CX2
R10
PF3
PA0
C16
R9
PF1
PF2
U8
R8
PF0
C37
PC0
R59
R18
1
R25 R26
C38
PC2
PC1
GND
+3.3 V
UX1
SO20W
U5
PC4
PC3
GND
CX1
C14
PC6
PC5
R17 C19 C15
PC7
JP7
PG0
JP9
PG2
JP8
PD4
C27 C22
C23
PD2
PD5
PG1
+5 V
+5 V
C36
PD3
PG3
JP10
PD6
GND/EGND
C35
PD7
R63
R64
R65
R66
C14
C15
JP13
C44 C39
C40 R22
C43 U8
R27
R30
C47
CORE MODULE
LINK
R54
R17
C10
C11
C12
JP4
C9
C13
JP11
R32
C48
R31
JP12
CE
R15
C49
C50
R16
BSY
SPD LNK FDX
ACT COL
R35
RCM3300
PROTOTYPING
BOARD
ACT
R10
R11
U5
R23
PF4 PF6 PE7
RP2
RP1
U4
R24 Y3
/RES_OUT
C8
JP14
PB0
R67
R68
R69
R70
C46
PB2
J11
BT1
2
PB4
PB3
R28
PB6
PB5
OUT
D1
PB7
C5
OUT 00 01 02 03 04 05 06 07
R29 U10
PF5
R9
R14
RABBITNET
R8 U6 C6
J10
U9
PE6
C4
R13
U1
R12
U7
U3
L293D
H-DRIVER
C45
PE5
R60 R61
C41
C42
PE3
PE4
U2
L293D
H-DRIVER
R52 R53
R55
R56
R57
R58
JP1
PE0
PE1
PF0_QD
JP2
PG6
PG7
C3
R51
+DC
GND
J1
J2
J3
D2
L1
PG5
PF7
C2
JP3
GND
DS1
+DC
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
PG4
+5V QD2A QD2B QD1A QD1B GND J5
/IORD
+5V
SM0
/IOWR
PF0_CLKD
C1
SMODE1
IN0
VRAM
IN1
VBT
/RES
IN2
+3.3 V
GND IN3
D1
NC
GND
J6
R1
J8
GND
J7
GND
The RCM3309/RCM3319 is automatically in Program Mode when the PROG connector
on the programming cable is attached, and is automatically in Run Mode when no programming cable is attached. When the Rabbit 3000 is reset, the operating mode is determined by the state of the SMODE pins. When the programming cable’s PROG connector
is attached, the SMODE pins are pulled high, placing the Rabbit 3000 in the Program Mode.
When the programming cable’s PROG connector is not attached, the SMODE pins are
pulled low, causing the Rabbit 3000 to operate in the Run Mode.
LCD1JC
Programming Cable
RESET
RESET RCM3309/RCM3319 when changing mode:
Press RESET button (if using Prototyping Board), OR
Cycle power off/on
after removing or attaching programming cable.
Figure 9. Switching Between Program Mode and Run Mode
User’s Manual
31
A program “runs” in either mode, but can only be downloaded and debugged when the
RCM3309/RCM3319 is in the Program Mode.
Refer to the Rabbit 3000 Microprocessor User’s Manual for more information on the programming port.
4.3.2 Standalone Operation of the RCM3309/RCM3319
The RCM3309/RCM3319 must be programmed via the Prototyping Board or via a similar
arrangement on a customer-supplied board. Once the RCM3309/RCM3319 has been programmed successfully, remove the programming cable from the programming connector
and reset the RCM3309/RCM3319. The RCM3309/RCM3319 may be reset by cycling the
power off/on or by pressing the RESET button on the Prototyping Board. The RCM3309/
RCM3319 module may now be removed from the Prototyping Board for end-use
installation.
CAUTION: Disconnect power to the Prototyping Board or other boards when removing
or installing your RCM3309/RCM3319 module to protect against inadvertent shorts
across the pins or damage to the RCM3309/RCM3319 if the pins are not plugged in
correctly. Do not reapply power until you have verified that the RCM3309/RCM3319
module is plugged in correctly.
32
RabbitCore RCM3309/RCM3319
4.4 Other Hardware
4.4.1 Clock Doubler
The RCM3309/RCM3319 takes advantage of the Rabbit 3000 microprocessor’s internal
clock doubler. A built-in clock doubler allows half-frequency crystals to be used to reduce
radiated emissions. The 44.2 MHz frequency specified for the RCM3309/RCM3319 is
generated using a 22.12 MHz resonator.
The clock doubler may be disabled if 44.2 MHz clock speeds are not required. This will
reduce power consumption and further reduce radiated emissions. The clock doubler is
disabled with a simple configuration macro as shown below.
1. Select the “Defines” tab from the Dynamic C Options > Project Options menu.
2. Add the line CLOCK_DOUBLED=0 to always disable the clock doubler.
The clock doubler is enabled by default, and usually no entry is needed. If you need to
specify that the clock doubler is always enabled, add the line CLOCK_DOUBLED=1 to
always enable the clock doubler.
3. Click OK to save the macro. The clock doubler will now remain off whenever you are
in the project file where you defined the macro.
4.4.2 Spectrum Spreader
The Rabbit 3000 features a spectrum spreader, which helps to mitigate EMI problems. The
spectrum spreader is on by default, but it may also be turned off or set to a stronger setting.
The means for doing so is through a simple configuration macro as shown below.
1. Select the “Defines” tab from the Dynamic C Options > Project Options menu.
2. Normal spreading is the default, and usually no entry is needed. If you need to specify
normal spreading, add the line
ENABLE_SPREADER=1
For strong spreading, add the line
ENABLE_SPREADER=2
To disable the spectrum spreader, add the line
ENABLE_SPREADER=0
NOTE: The strong spectrum-spreading setting is unnecessary for the RCM3309/
RCM3319.
3. Click OK to save the macro. The spectrum spreader will now be set to the state specified
by the macro value whenever you are in the project file where you defined the macro.
NOTE: Refer to the Rabbit 3000 Microprocessor User’s Manual for more information
on the spectrum-spreading setting and the maximum clock speed.
User’s Manual
33
4.5 Memory
4.5.1 SRAM
RCM3309/RCM3319 boards have 512K of program-execution fast SRAM at U66. The
program-execution SRAM is not battery-backed. There are 512K of battery-backed data
SRAM installed at U9.
4.5.2 Flash EPROM
RCM3309/RCM3319 boards also have 512K of flash EPROM at U8.
NOTE: Rabbit recommends that any customer applications should not be constrained by
the sector size of the flash EPROM since it may be necessary to change the sector size
in the future.
Writing to arbitrary flash memory addresses at run time is also discouraged. Instead, use a
portion of the “user block” area to store persistent data. The functions writeUserBlock() and readUserBlock() are provided for this. Refer to the Rabbit 3000
Microprocessor Designer’s Handbook and the Dynamic C Function Reference Manual for
additional information.
A Flash Memory Bank Select jumper configuration option based on 0 Ω surface-mounted
resistors exists at header JP12 on the RCM3309/RCM3319 RabbitCore modules. This
option, used in conjunction with some configuration macros, allows Dynamic C to
compile two different co-resident programs for the upper and lower halves of a 256K flash
in such a way that both programs start at logical address 0000. This is useful for applications that require a resident download manager and a separate downloaded program. See
Rabbit’s Technical Note TN218, Implementing a Serial Download Manager for a 256K
Flash, for details.
4.5.3 Serial Flash
A serial flash is supplied on the RCM3309 and the RCM3319 to store data and Web pages.
Sample programs in the SAMPLES\RCM3300 folder illustrate the use of the serial flash.
These sample programs are described in Section 3.2.1, “Use of Serial Flash.”
4.5.4 Dynamic C BIOS Source Files
The Dynamic C BIOS source files handle different standard RAM and flash EPROM sizes
automatically.
34
RabbitCore RCM3309/RCM3319
5. SOFTWARE REFERENCE
Dynamic C is an integrated development system for writing
embedded software. It runs on an IBM-compatible PC and is
designed for use with controllers based on the Rabbit microprocessor. Chapter 5 describes the libraries and function calls
related to the RCM3309/RCM3319.
5.1 More About Dynamic C
Dynamic C has been in use worldwide since 1989. It is specially designed for programming embedded systems, and features quick compile and interactive debugging. A complete reference guide to Dynamic C is contained in the Dynamic C User’s Manual.
You have a choice of doing your software development in the flash memory or in the static
SRAM included on the RCM3309/RCM3319. The flash memory and SRAM options are
selected with the Options > Program Options > Compiler menu.
The advantage of working in RAM is to save wear on the flash memory, which is limited
to about 100,000 write cycles. The disadvantage is that the code and data might not both
fit in RAM.
NOTE: An application should be run from the program execution SRAM after the programming cable is disconnected. Your final code must always be stored in flash memory
for reliable operation. RCM3309/RCM3319 modules running at 44.2 MHz have a fast
program execution SRAM that is not battery-backed. Select Code and BIOS in Flash,
Run in RAM from the Dynamic C Options > Project Options > Compiler menu to
store the code in flash and copy it to the fast program execution SRAM at run-time to
take advantage of the faster clock speed. This option optimizes the performance of
RCM3309/RCM3319 modules running at 44.2 MHz.
NOTE: Do not depend on the flash memory sector size or type in your program logic.
The RCM3309/RCM3319 and Dynamic C were designed to accommodate flash
devices with various sector sizes in response to the volatility of the flash-memory
market.
Developing software with Dynamic C is simple. Users can write, compile, and test C and
assembly code without leaving the Dynamic C development environment. Debugging occurs
while the application runs on the target. Alternatively, users can compile a program to an
image file for later loading. Dynamic C runs on PCs under Windows 2000/NT and later—
see Rabbit’s Technical Note TN257, Running Dynamic C® With Windows Vista®, for
User’s Manual
35
additional information if you are using a Dynamic C release prior to v. 9.60 under Windows
Vista. Programs can be downloaded at baud rates of up to 460,800 bps after the program
compiles.
Dynamic C has a number of standard features.
• Full-feature source and/or assembly-level debugger, no in-circuit emulator required.
• Royalty-free TCP/IP stack with source code and most common protocols.
• Hundreds of functions in source-code libraries and sample programs:
X Exceptionally fast support for floating-point arithmetic and transcendental functions.
X RS-232 and RS-485 serial communication.
X Analog and digital I/O drivers.
X I2C, SPI, GPS, file system.
X LCD display and keypad drivers.
• Powerful language extensions for cooperative or preemptive multitasking
• Loader utility program to load binary images into Rabbit targets in the absence of
Dynamic C.
• Provision for customers to create their own source code libraries and augment on-line
help by creating “function description” block comments using a special format for
library functions.
• Standard debugging features:
X Breakpoints—Set breakpoints that can disable interrupts.
X Single-stepping—Step into or over functions at a source or machine code level, µC/OS-II aware.
X Code disassembly—The disassembly window displays addresses, opcodes, mnemonics, and
machine cycle times. Switch between debugging at machine-code level and source-code level by
simply opening or closing the disassembly window.
X Watch expressions—Watch expressions are compiled when defined, so complex expressions
including function calls may be placed into watch expressions. Watch expressions can be updated
with or without stopping program execution.
X Register window—All processor registers and flags are displayed. The contents of general registers
may be modified in the window by the user.
X Stack window—shows the contents of the top of the stack.
X Hex memory dump—displays the contents of memory at any address.
X STDIO window—printf outputs to this window and keyboard input on the host PC can be
detected for debugging purposes. printf output may also be sent to a serial port or file.
36
RabbitCore RCM3309/RCM3319
5.1.1 Developing Programs Remotely with Dynamic C
Dynamic C is an integrated development environment that allows you to edit, compile,
and debug your programs. Dynamic C has the ability to allow programming over the
Internet or local Ethernet. This is accomplished in one of two ways.
1. Via the RabbitLink, which allows a Rabbit-based target to have programs downloaded
to it and debugged with the same ease as exists when the target is connected directly to
a PC.
2. The RCM3309/RCM3319 has a featured remote application update written specifically
to allow the RCM3309/RCM3319 to be programmed over the Internet or local Ethernet.
These programs, DLP_STATIC.C and DLP_WEB.C, are available in the Dynamic C
SAMPLES\RCM3300\RemoteApplicationUpdate folder. Complete information on
the use of these programs is provided in the Remote Application Update instructions,
which are available with the online documentation.
Dynamic C provides sample programs to illustrate the use of a download manager.
User’s Manual
37
5.2 Dynamic C Functions
5.2.1 Digital I/O
The RCM3309/RCM3319 was designed to interface with other systems, and so there are
no drivers written specifically for the I/O. The general Dynamic C read and write functions
allow you to customize the parallel I/O to meet your specific needs. For example, use
WrPortI(PEDDR, &PEDDRShadow, 0x00);
to set all the Port E bits as inputs, or use
WrPortI(PEDDR, &PEDDRShadow, 0xFF);
to set all the Port E bits as outputs.
When using the auxiliary I/O bus on the Rabbit 3000 chip, add the line
#define PORTA_AUX_IO
// required to enable auxiliary I/O bus
to the beginning of any programs using the auxiliary I/O bus.
The sample programs in the Dynamic C SAMPLES/RCM3300 folder provide further
examples.
5.2.2 SRAM Use
The RCM3309/RCM3319 have a battery-backed data SRAM and a program-execution
SRAM. Dynamic C provides the protected keyword to identify variables that are to be
placed into the battery-backed SRAM. The compiler generates code that creates a backup
copy of a protected variable before the variable is modified. If the system resets while the
protected variable is being modified, the variable's value can be restored when the system
restarts.
The sample code below shows how a protected variable is defined and how its value can
be restored.
protected nf_device nandFlash;
int main() {
...
_sysIsSoftReset();
// restore any protected variables
The bbram keyword may also be used instead if there is a need to store a variable in battery-backed SRAM without affecting the performance of the application program. Data
integrity is not assured when a reset or power failure occurs during the update process.
Additional information on bbram and protected variables is available in the Dynamic C
User’s Manual.
38
RabbitCore RCM3309/RCM3319
5.2.3 Serial Communication Drivers
Library files included with Dynamic C provide a full range of serial communications support. The LIB\RS232.LIB library provides a set of circular-buffer-based serial functions.
The LIB\PACKET.LIB library provides packet-based serial functions where packets can be
delimited by the 9th bit, by transmission gaps, or with user-defined special characters.
Both libraries provide blocking functions, which do not return until they are finished
transmitting or receiving, and nonblocking functions, which must be called repeatedly
until they are finished, allowing other functions to be performed between calls. For more
information, see the Dynamic C Function Reference Manual and Rabbit’s Technical
Note TN213, Rabbit Serial Port Software in the online documentation.
5.2.4 TCP/IP Drivers
The TCP/IP drivers are located in the LIB\TCPIP folder. Complete information on these
libraries and the TCP/IP functions is provided in the Dynamic C TCP/IP User’s Manual.
5.2.5 Serial Flash Drivers
The Dynamic C LIB\SerialFlash\SFLASH.LIB library is used to interface to serial
flash memory devices on an SPI bus such as the serial flash on board the RCM3309 and
the RCM3319, which use Serial Port B as an SPI port. The library has two sets of function
calls—the first is maintained for compatibility with previous versions of the LIB\
SFLASH.LIB library. The functions are all blocking and only work for single flash devices.
The new functions, which should be used for the RCM3309/RCM3319, make use of an
sf_device structure as a handle for a specific serial flash device. This allows multiple
devices to be used by an application.
More information on these function calls is available in the Dynamic C Function Reference Manual.
The serial flash mass storage may also be used to store files with a directory structure. The
Dynamic C FAT file system included with Dynamic C provides support for a file system
and for formatting the serial flash memory in a Rabbit-based system. This allows files to
be read and written in a PC-compatible manner. The supporting documentation for the
Dynamic C FAT File System and the sample programs in the SAMPLES\FileSystem\
FAT folder illustrate the use of the Dynamic C FAT file system.
User’s Manual
39
5.2.6 Prototyping Board Function Calls
The functions described in this section are for use with the Prototyping Board features.
The source code is in the Dynamic C SAMPLES\RCM3300\RCM33xx.LIB library if you
need to modify it for your own board design.
The RCM33xx.LIB library is supported by the RN_CFG_RCM33.LIB—library, which is
used to configure the RCM3309/RCM3319 for use with RabbitNet peripheral boards on
the Prototyping Board.
Other generic functions applicable to all devices based on Rabbit microprocessors are
described in the Dynamic C Function Reference Manual.
5.2.6.1 Board Initialization
brdInit
void brdInit (void);
DESCRIPTION
Call this function at the beginning of your program. This function initializes Parallel
Ports A through G for use with the Prototyping Board.
This function call is intended for demonstration purposes only, and can be modified for
your applications.
Summary of Initialization
1.
I/O port pins are configured for Prototyping Board operation.
2.
Unused configurable I/O are set as tied inputs or outputs.
3.
The external I/O bus is enabled.
4.
The LCD/keypad module is disabled.
5.
RS-485 is not enabled.
6.
RS-232 is not enabled.
7.
LEDs are off.
8.
Ethernet select is disabled.
9.
Mass-storage serial flash select is disabled.
10. Motor control is disabled.
11. The RabbitNet SPI interface is disabled.
12. The relay is set to normally closed positions.
RETURN VALUE
None.
40
RabbitCore RCM3309/RCM3319
5.2.6.2 Digital I/O
digIn
int digIn(int channel);
DESCRIPTION
Reads the input state of a digital input on headers J5 and J6 on the Prototyping Board.
Do not use this function call if you configure these pins for alternate use after
brdInit() is called.
A runtime error will occur if brdInit() has not been called first.
PARAMETER
channel
the channel number corresponding to the digital input channel:
0—IN0
1—IN1
2—IN2
3—IN3
4—QD1B
5—QD1A
6—QD2B
7—QD2A
RETURN VALUE
The logic state (0 or 1) of the input. A run-time error will occur if the channel
parameter is out of range.
SEE ALSO
brdInit
User’s Manual
41
digOut
void digOut(int channel, int value);
DESCRIPTION
Writes a value to an output channel on Prototyping Board header J10. Do not use this
function if you have installed the stepper motor chips at U2 and U3.
PARAMETERS
channel
output channel 0–7 (OUT00–OUT07).
value
value (0 or 1) to output.
RETURN VALUE
None.
SEE ALSO
brdInit
42
RabbitCore RCM3309/RCM3319
5.2.6.3 Switches, LEDs, and Relay
switchIn
int switchIn(int swin);
DESCRIPTION
Reads the state of a switch input.
A runtime error will occur if brdInit() has not been called first or if the swin
parameter is invalid.
PARAMETERS
swin
switch input to read:
2—S2
3—S3
RETURN VALUE
State of the switch input:
1 = open
0 = closed
SEE ALSO
brdInit
User’s Manual
43
ledOut
void ledOut(int led, int value);
DESCRIPTION
Controls LEDs on the Prototyping Board and on the RCM3309/RCM3319.
A runtime error will occur if brdInit() has not been called first.
PARAMETERS
led
the LED to control:
0 = red BSY LED on RCM3309/RCM3319
3 = DS3 on Prototyping Board
4 = DS4 on Prototyping Board
5 = DS5 on Prototyping Board
6 = DS6 on Prototyping Board
value
the value used to control the LED:
0 = off
1 = on
RETURN VALUE
None.
SEE ALSO
brdInit
44
RabbitCore RCM3309/RCM3319
relayOut
void relayOut(int relay, int value);
DESCRIPTION
Sets the position for the relay common contact. The default position is for normally
closed contacts.
A runtime error will occur if brdInit() has not been called first.
PARAMETERS
relay
the one relay (1)
value
the value used to connect the relay common contact:
0 = normally closed positions (NC1 and NC2)
1 = normally open positions (NO1 and NO2)
RETURN VALUE
None.
SEE ALSO
brdInit
User’s Manual
45
5.2.6.4 Serial Communication
ser485Tx
void ser485Tx(void);
DESCRIPTION
Enables the RS-485 transmitter. Transmitted data are echoed back into the receive data
buffer. The echoed data may be used as an indicator for disabling the transmitter by using
one of the following methods:
Byte mode—disable the transmitter after the same byte that is transmitted is detected in the
receive data buffer.
Block data mode—disable the transmitter after the same number of bytes transmitted are
detected in the receive data buffer.
Remember to call the serXopen() function before running this function.
RETURN VALUE
None.
SEE ALSO
ser485Rx
ser485Rx
void ser485Rx(void);
DESCRIPTION
Disables the RS-485 transmitter. This puts the device into the listen mode, which allows
it to receive data from the RS-485 interface.
Remember to call the serXopen() function before running this function.
RETURN VALUE
None.
SEE ALSO
ser485Tx
46
RabbitCore RCM3309/RCM3319
5.2.6.5 RabbitNet Port
The function calls described in this section are used to configure the RabbitNet port on the
Prototyping Board for use with RabbitNet peripheral cards. The user’s manual for the specific peripheral card you are using contains additional function calls related to the RabbitNet protocol and the individual peripheral card. Appendix 0 provides additional
information about the RabbitNet.
These RabbitNet peripheral cards are available at the present time.
• Digital I/O Card (RN1100)
• Relay Card (RN1400)
• A/D Converter Card (RN1200)
• Keypad/Display Interface (RN1600)
• D/A Converter Card (RN1300)
Before using the RabbitNet port, add the following lines at the start of your program.
#define RN_MAX_DEV 10 // max number of devices
#define RN_MAX_DATA 16 // max number of data bytes in any transaction
#define RN_MAX_PORT 2 // max number of serial ports
Set the following bits in RNSTATUSABORT to abort transmitting data after the status byte is
returned. This does not affect the status byte and still can be interpreted. Set any bit combination to abort:
bit 7—device busy is hard-coded into driver
bit 5—identifies router or slave
bits 4,3,2—peripheral-board-specific bits
bit 1—command rejected
bit 0—watchdog timeout
#define RNSTATUSABORT 0x80
// hard-coded driver default to abort if the peripheral board is busy
rn_sp_info
void rn_sp_info();
DESCRIPTION
Provides rn_init() with the serial port control information needed for RCM3309/
RCM3319 modules.
RETURN VALUE
None.
User’s Manual
47
rn_sp_close
void rn_sp_close(int port);
DESCRIPTION
Deactivates the RCM3309/RCM3319 RabbitNet port as a clocked serial port. This call
is also used by rn_init().
PARAMETER
portnum
=0
RETURN VALUE
None.
rn_sp_enable
void rn_sp_enable(int portnum);
DESCRIPTION
This is a macro that enables or asserts the RCM3309/RCM3319 RabbitNet port chip
select prior to data transfer.
PARAMETER
portnum
=0
RETURN VALUE
None.
rn_sp_disable
void rn_sp_disable(int portnum);
DESCRIPTION
This is a macro that disables or deasserts the RCM3309/RCM3319 RabbitNet port chip
select to invalidate data transfer.
PARAMETER
portnum
=0
RETURN VALUE
None.
48
RabbitCore RCM3309/RCM3319
5.3 Upgrading Dynamic C
Dynamic C patches that focus on bug fixes are available from time to time. Check the Web
site www.rabbit.com/support/ for the latest patches, workarounds, and bug fixes.
5.3.1 Extras
Dynamic C installations are designed for use with the board they are included with, and
are included at no charge as part of our low-cost kits.
Starting with Dynamic C version 9.60, which is included with the RCM3309/RCM3319
Development Kit, Dynamic C includes the popular µC/OS-II real-time operating system,
point-to-point protocol (PPP), FAT file system, RabbitWeb, and other select libraries. Rabbit
also offers for purchase the Rabbit Embedded Security Pack featuring the Secure Sockets
Layer (SSL) and a specific Advanced Encryption Standard (AES) library.
In addition to the Web-based technical support included at no extra charge, a one-year
telephone-based technical support subscription is also available for purchase.
Visit our Web site at www.rabbit.com for further information and complete documentation.
User’s Manual
49
50
RabbitCore RCM3309/RCM3319
6. USING THE TCP/IP FEATURES
6.1 TCP/IP Connections
Programming and development can be done with the RCM3309/RCM3319 modules without connecting the Ethernet port to a network. However, if you will be running the sample
programs that use the Ethernet capability or will be doing Ethernet-enabled development,
you should connect the RCM3309/RCM3319 module’s Ethernet port at this time.
Before proceeding you will need to have the following items.
• If you don’t have Ethernet access, you will need at least a 10Base-T Ethernet card
(available from your favorite computer supplier) installed in a PC.
• One Cat. 5 straight through or crossover Ethernet cable.
A straight-through and a crossover Ethernet cable are included in the RCM3309/RCM3319
Development Kit. Figure 10 shows how to identify the two cables based on the wires in the
transparent RJ-45 connectors.
Same
color order
in connectors
StraightThrough
Cable
Different
color order
in connectors
Crossover
Cable
Figure 10. How to Identify Straight-Through and Crossover Ethernet Cables
Ethernet cables and a 10Base-T Ethernet hub are available in a TCP/IP tool kit. More
information is available at www.rabbit.com.
User’s Manual
51
Now you should be able to make your connections.
1. Connect the AC adapter and the programming cable as shown in Chapter 2, “Getting
Started.”
2. Ethernet Connections
There are four options for connecting the RCM3309/RCM3319 module to a network
for development and runtime purposes. The first two options permit total freedom of
action in selecting network addresses and use of the “network,” as no action can interfere with other users. We recommend one of these options for initial development.
• No LAN — The simplest alternative for desktop development. Connect the RCM3309/
RCM3319 module’s Ethernet port directly to the PC’s network interface card using
either a Cat. 5 crossover cable or a Cat. 5 straight-through cable.
• Micro-LAN — Another simple alternative for desktop development. Use a small
Ethernet 10Base-T hub and connect both the PC’s network interface card and the
RCM3309/RCM3319 module’s Ethernet port to it using standard network cables.
The following options require more care in address selection and testing actions, as
conflicts with other users, servers and systems can occur:
• LAN — Connect the RCM3309/RCM3319 module’s Ethernet port to an existing
LAN, preferably one to which the development PC is already connected. You will need
to obtain IP addressing information from your network administrator.
• WAN — The RCM3309/RCM3319 is capable of direct connection to the Internet and
other Wide Area Networks, but exceptional care should be used with IP address
settings and all network-related programming and development. We recommend that
development and debugging be done on a local network before connecting a RabbitCore system to the Internet.
TIP: Checking and debugging the initial setup on a micro-LAN is recommended before
connecting the system to a LAN or WAN.
The PC running Dynamic C does not need to be the PC with the Ethernet card.
3. Apply Power
Plug in the AC adapter. The RCM3309/RCM3319 module and Prototyping Board are
now ready to be used.
52
RabbitCore RCM3309/RCM3319
6.2 TCP/IP Primer on IP Addresses
Obtaining IP addresses to interact over an existing, operating, network can involve a number
of complications, and must usually be done with cooperation from your ISP and/or network
systems administrator. For this reason, it is suggested that the user begin instead by using a
direct connection between a PC and the RCM3309/RCM3319.
In order to set up this direct connection, the user will have to use a PC without networking,
or disconnect a PC from the corporate network, or install a second Ethernet adapter and set
up a separate private network attached to the second Ethernet adapter. Disconnecting your
PC from the corporate network may be easy or nearly impossible, depending on how it is
set up. If your PC boots from the network or is dependent on the network for some or all
of its disks, then it probably should not be disconnected. If a second Ethernet adapter is
used, be aware that Windows TCP/IP will send messages to one adapter or the other,
depending on the IP address and the binding order in Microsoft products. Thus you should
have different ranges of IP addresses on your private network from those used on the corporate network. If both networks service the same IP address, then Windows may send a
packet intended for your private network to the corporate network. A similar situation will
take place if you use a dial-up line to send a packet to the Internet. Windows may try to
send it via the local Ethernet network if it is also valid for that network.
The following IP addresses are set aside for local networks and are not allowed on the
Internet: 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, and 192.168.0.0 to
192.168.255.255.
The RCM3309/RCM3319 uses a 10/100Base-T type of Ethernet connection, which is the
most common scheme. The RJ-45 connectors are similar to U.S. style telephone connectors, except they are larger and have 8 contacts.
An alternative to the direct connection is a connection using a hub. The hub relays packets
received on any port to all of the ports on the hub. Hubs are low in cost and are readily
available. The RCM3309/RCM3319 uses 10/100 Mbps Ethernet, so the hub or Ethernet
adapter should be a 10/100 Mbps unit.
In a corporate setting where the Internet is brought in via a high-speed line, there are typically machines between the outside Internet and the internal network. These machines
include a combination of proxy servers and firewalls that filter and multiplex Internet traffic. In the configuration below, the RCM3309/RCM3319 could be given a fixed address
so any of the computers on the local network would be able to contact it. It may be possible to configure the firewall or proxy server to allow hosts on the Internet to directly contact the controller, but it would probably be easier to place the controller directly on the
external network outside of the firewall. This avoids some of the configuration complications by sacrificing some security.
User’s Manual
53
Hub(s)
T1 in
Adapter
Ethernet
Firewall
Proxy
Server
Network
Ethernet
Typical Corporate Network
RCM3309/RCM3319
System
If your system administrator can give you an Ethernet cable along with the network IP
address, the netmask and the gateway address, then you may be able to run the sample
programs without having to setup a direct connection between your computer and the
RCM3309/RCM3319. You will also need the IP address of the nameserver, the name or IP
address of your mail server, and your domain name for some of the sample programs.
54
RabbitCore RCM3309/RCM3319
6.2.1 IP Addresses Explained
IP (Internet Protocol) addresses are expressed as 4 decimal numbers separated by periods,
for example:
216.103.126.155
10.1.1.6
Each decimal number must be between 0 and 255. The total IP address is a 32-bit number
consisting of the 4 bytes expressed as shown above. A local network uses a group of adjacent IP addresses. There are always 2N IP addresses in a local network. The netmask (also
called subnet mask) determines how many IP addresses belong to the local network. The
netmask is also a 32-bit address expressed in the same form as the IP address. An example
netmask is:
255.255.255.0
This netmask has 8 zero bits in the least significant portion, and this means that 28
addresses are a part of the local network. Applied to the IP address above (216.103.126.
155), this netmask would indicate that the following IP addresses belong to the local network:
216.103.126.0
216.103.126.1
216.103.126.2
etc.
216.103.126.254
216.103.126.255
The lowest and highest address are reserved for special purposes. The lowest address
(216.102.126.0) is used to identify the local network. The highest address (216.102.126.
255) is used as a broadcast address. Usually one other address is used for the address of
the gateway out of the network. This leaves 256 - 3 = 253 available IP addresses for the
example given.
User’s Manual
55
6.2.2 How IP Addresses are Used
The actual hardware connection via an Ethernet uses Ethernet adapter addresses (also
called MAC addresses). These are 48-bit addresses and are unique for every Ethernet
adapter manufactured. In order to send a packet to another computer, given the IP address
of the other computer, it is first determined if the packet needs to be sent directly to the
other computer or to the gateway. In either case, there is an Ethernet address on the local
network to which the packet must be sent. A table is maintained to allow the protocol
driver to determine the MAC address corresponding to a particular IP address. If the table
is empty, the MAC address is determined by sending an Ethernet broadcast packet to all
devices on the local network asking the device with the desired IP address to answer with
its MAC address. In this way, the table entry can be filled in. If no device answers, then
the device is nonexistent or inoperative, and the packet cannot be sent.
Some IP address ranges are reserved for use on internal networks, and can be allocated
freely as long as no two internal hosts have the same IP address. These internal IP
addresses are not routed to the Internet, and any internal hosts using one of these reserved
IP addresses cannot communicate on the external Internet without being connected to a
host that has a valid Internet IP address. The host would either translate the data, or it
would act as a proxy.
Each RCM3309/RCM3319 RabbitCore module has its own unique MAC address, which
consists of the prefix 0090C2 followed by a code that is unique to each RCM3309/
RCM3319 module. For example, a MAC address might be 0090C2C002C0.
TIP: You can always obtain the MAC address on your board by running the sample program DISPLAY_MAC.C from the SAMPLES\TCPIP folder.
56
RabbitCore RCM3309/RCM3319
6.2.3 Dynamically Assigned Internet Addresses
In many instances, devices on a network do not have fixed IP addresses. This is the case
when, for example, you are assigned an IP address dynamically by your dial-up Internet
service provider (ISP) or when you have a device that provides your IP addresses using
the Dynamic Host Configuration Protocol (DHCP). The RCM3309/RCM3319 modules
can use such IP addresses to send and receive packets on the Internet, but you must take
into account that this IP address may only be valid for the duration of the call or for a
period of time, and could be a private IP address that is not directly accessible to others on
the Internet. These addresses can be used to perform some Internet tasks such as sending
e-mail or browsing the Web, but it is more difficult to participate in conversations that
originate elsewhere on the Internet. If you want to find out this dynamically assigned IP
address, under Windows 98 you can run the winipcfg program while you are connected
and look at the interface used to connect to the Internet.
Many networks use IP addresses that are assigned using DHCP. When your computer
comes up, and periodically after that, it requests its networking information from a DHCP
server. The DHCP server may try to give you the same address each time, but a fixed IP
address is usually not guaranteed.
If you are not concerned about accessing the RCM3309/RCM3319 from the Internet, you
can place the RCM3309/RCM3319 on the internal network using an IP address assigned
either statically or through DHCP.
User’s Manual
57
6.3 Placing Your Device on the Network
In many corporate settings, users are isolated from the Internet by a firewall and/or a
proxy server. These devices attempt to secure the company from unauthorized network
traffic, and usually work by disallowing traffic that did not originate from inside the network. If you want users on the Internet to communicate with your RCM3309/RCM3319,
you have several options. You can either place the RCM3309/RCM3319 directly on the
Internet with a real Internet address or place it behind the firewall. If you place the
RCM3309/RCM3319 behind the firewall, you need to configure the firewall to translate
and forward packets from the Internet to the RCM3309/RCM3319.
58
RabbitCore RCM3309/RCM3319
6.4 Running TCP/IP Sample Programs
We have provided a number of sample programs demonstrating various uses of TCP/IP for
networking embedded systems. These programs require you to connect your PC and the
RCM3309/RCM3319 board together on the same network. This network can be a local private network (preferred for initial experimentation and debugging), or a connection via the
Internet.
RCM3309/RCM3319
System
User’s PC
Cat. 5
Ethernet
cable
Direct Connection
(network of 2 computers)
User’s Manual
RCM3309/RCM3319
System
Ethernet
cables
Hub
To additional
network
elements
Direct Connection Using a Hub
59
6.4.1 How to Set IP Addresses in the Sample Programs
With the introduction of Dynamic C 7.30 we have taken steps to make it easier to run
many of our sample programs. You will see a TCPCONFIG macro. This macro tells
Dynamic C to select your configuration from a list of default configurations. You will
have three choices when you encounter a sample program with the TCPCONFIG macro.
1. You can replace the TCPCONFIG macro with individual MY_IP_ADDRESS, MY_NETMASK, MY_GATEWAY, and MY_NAMESERVER macros in each program.
2. You can leave TCPCONFIG at the usual default of 1, which will set the IP configurations
to 10.10.6.100, the netmask to 255.255.255.0, and the nameserver and gateway
to 10.10.6.1. If you would like to change the default values, for example, to use an IP
address of 10.1.1.2 for the RCM3309/RCM3319 board, and 10.1.1.1 for your PC,
you can edit the values in the section that directly follows the “General Configuration”
comment in the TCP_CONFIG.LIB library. You will find this library in the LIB\TCPIP
directory.
3. You can create a CUSTOM_CONFIG.LIB library and use a TCPCONFIG value greater
than 100. Instructions for doing this are at the beginning of the TCP_CONFIG.LIB
library in the LIB\TCPIP directory.
There are some other “standard” configurations for TCPCONFIG that let you select different features such as DHCP. Their values are documented at the top of the TCP_CONFIG.
LIB library in the LIB\TCPIP directory. More information is available in the Dynamic C
TCP/IP User’s Manual.
60
RabbitCore RCM3309/RCM3319
6.4.2 How to Set Up your Computer for Direct Connect
Follow these instructions to set up your PC or notebook. Check with your administrator if
you are unable to change the settings as described here since you may need administrator
privileges. The instructions are specifically for Windows 2000, but the interface is similar
for other versions of Windows.
TIP: If you are using a PC that is already on a network, you will disconnect the PC from
that network to run these sample programs. Write down the existing settings before
changing them to facilitate restoring them when you are finished with the sample programs and reconnect your PC to the network.
1. Go to the control panel (Start > Settings > Control Panel), and then double-click the
Network icon.
2. Select the network interface card used for the Ethernet interface you intend to use (e.g.,
TCP/IP Xircom Credit Card Network Adapter) and click on the “Properties” button.
Depending on which version of Windows your PC is running, you may have to select
the “Local Area Connection” first, and then click on the “Properties” button to bring up
the Ethernet interface dialog. Then “Configure” your interface card for a “10Base-T
Half-Duplex” or an “Auto-Negotiation” connection on the “Advanced” tab.
NOTE: Your network interface card will likely have a different name.
3. Now select the IP Address tab, and check Specify an IP Address, or select TCP/IP and
click on “Properties” to assign an IP address to your computer (this will disable “obtain
an IP address automatically”):
IP Address : 10.10.6.101
Netmask : 255.255.255.0
Default gateway : 10.10.6.1
4. Click or to exit the various dialog boxes.
RCM3309/RCM3319
System
IP 10.10.6.101
Netmask
255.255.255.0
User’s PC
Cat. 5
Ethernet
cable
Direct Connection PC to RCM3309/RCM3319 Board
User’s Manual
61
6.5 Run the PINGME.C Sample Program
Connect a Cat. 5 Ethernet cable from your computer’s Ethernet port to the RCM3309/
RCM3319 board’s RJ-45 Ethernet connector. Open this sample program from the
SAMPLES\TCPIP\ICMP folder, compile the program, and start it running under Dynamic C.
When the program starts running, the green LNK/ACT light on the RCM3309/RCM3319
module should be on to indicate an Ethernet connection is made. (Note: If the LNK/ACT
light does not light and you are using a hub, check that the power is not off on the hub.)
The next step is to ping the board from your PC. This can be done by bringing up the MSDOS window and running the pingme program:
ping 10.10.6.101
or by Start > Run
and typing the entry
ping 10.10.6.101
Notice that the green LNK/ACT light flashes on the RCM3309/RCM3319 module while
the ping is taking place, and indicates the transfer of data. The ping routine will ping the
board four times and write a summary message on the screen describing the operation.
6.6 Running Additional Sample Programs With Direct Connect
The following sample programs are in the Dynamic C SAMPLES\RCM3300\TCPIP\
folder.
• BROWSELED.C—This program demonstrates a basic controller running a Web page.
Two “device LEDs” are created along with two buttons to toggle them. Users can use
their Web browser to change the state of the lights. The DS3 and DS4 LEDs on the Prototyping Board will match those on the Web page. As long as you have not modified
the TCPCONFIG 1 macro in the sample program, enter the following server address in
your Web browser to bring up the Web page served by the sample program.
http://10.10.6.100
Otherwise use the TCP/IP settings you entered in the TCP_CONFIG.LIB library.
• MBOXDEMO.C—The optional LCD/keypad module (see Appendix C) must be plugged
in to the Prototyping Board when using this sample program. This program demonstrates sending e-mail messages that are then shown on the LCD/keypad module display. The keypad is used to scroll through a menu to view the messages, flip to other
messages, mark messages as read, and delete messages. When a new e-mail arrives, an
LED on the LCD/keypad module turns on, and then turns off once the message has
been marked as read. A log of all e-mail actions is kept, and can be displayed in the
Web browser. All current e-mails can also be read with the Web browser.
• PINGLED.C—This program demonstrates ICMP by pinging a remote host. It will flash
LEDs DS3 and DS4 on the Prototyping Board when a ping is sent and received.
62
RabbitCore RCM3309/RCM3319
• SMTP.C—This program demonstrates using the SMTP library to send an e-mail when
the S2 and S3 switches on the Prototyping Board are pressed. LEDs DS3 and DS4 on
the Prototyping Board will light up when e-mail is being sent.
6.6.1 RabbitWeb Sample Programs
The following sample programs are in the Dynamic C SAMPLES\RCM3300\TCPIP\
RABBITWEB folder.
• BLINKLEDS.C—This program demonstrates a basic example to change the rate at
which the DS3 and DS4 LEDs on the Prototyping Board blink.
• DOORMONITOR.C—The optional LCD/keypad module (see Appendix C) must be plugged
in to the Prototyping Board when using this sample program. This program demonstrates adding and monitoring passwords entered via the LCD/keypad module.
• SPRINKLER.C—This program demonstrates how to schedule times for the relay and
digital outputs in a 24-hour period.
6.6.2 Remote Application Update
The following programs that make up the featured application for the RCM3309/
RCM3319 can be found in the SAMPLES\RCM3300\RemoteApplicationUpdate folder.
• DLP_STATIC.C—This program uses the TCP/IP LIB\TCPIP\HTTP.LIB library, and
outputs a basic static Web page.
• DLP_WEB.C—This program outlines a basic download program with a Web interface.
Complete information on the use of these programs is provided in the Remote Application
Update instructions, which are available with the online documentation.
6.6.3 Dynamic C FAT File System, RabbitWeb, and SSL Libraries
The Dynamic C FAT File System, RabbitWeb, and Secure Sockets Layer (SSL) libraries
have been integrated into a sample program for the RCM3309 and the RCM3319. The sample program requires that you have installed the optional Rabbit Embedded Security Pack.
TIP: Before running any of the sample programs described in this section, you should
look at and run sample programs for the TCP/IP LIB\TCPIP\ZSERVER.LIB library,
the FAT file system, RabbitWeb, SSL, the download manager, and HTTP upload to
become more familiar with their operation.
The INTEGRATION.C sample program in the SAMPLES\RCM3300\Module_Integration folder demonstrates the use of the TCP/IP LIB\TCPIP\ZSERVER.LIB library and
FAT file system functionality with RabbitWeb dynamic HTML content, all secured using
SSL. The sample program also supports dynamic updates of both the application and its
resources using the Rabbit Download Manager (DLM) and HTTP upload capability,
respectively—note that neither of these currently supports SSL security.
First, you need to format and partition the serial flash. Find the FMT_DEVICE.C sample
program in the Dynamic C SAMPLES\FileSystem folder. Open this sample program
with the File > Open menu, then compile and run it by pressing F9. FMT_DEVICE.C
User’s Manual
63
formats the mass storage device for use with the FAT file system. If the serial flash or
NAND flash is already formatted, FMT_DEVICE.C gives you the option of erasing the
mass storage flash and reformatting it with a single large partition. This erasure does not
check for non-FAT partitions and will destroy all existing partitions.
Next, run the INTEGRATION_FAT_SETUP.C sample program in the Dynamic C
SAMPLES\RCM3300\Module_Integration folder. Open this sample program with the
File > Open menu, then compile and run it by pressing F9. INTEGRATION_FAT_SETUP.
C will copy some #ximported files into the FAT file system.
The last step to complete before you can run the INTEGRATION.C sample program is to
create an SSL certificate. The SSL walkthrough in the online documentation for the
Dynamic C SSL module explains how to do this.
Now you are ready to run the INTEGRATION.C sample program in the Dynamic C
SAMPLES\RCM3300\Module_Integration folder. Open this sample program with the
File > Open menu, then compile and run it by pressing F9.
NOTE: Since HTTP upload and the Dynamic C SSL module currently do not work
together, compiling the INTEGRATION.C sample program will generate a serious
warning. Ignore the warning because we are not using HTTP upload over SSL. A
macro (HTTP_UPLOAD_SSL_SUPRESS_WARNING) is available to suppress the
warning message.
Open a Web browser, and browse to the device using the IP address from the TCP_
CONFIG.LIB library or the URL you assigned to the device. The humidity monitor will
be displayed in your Web browser. This page is accessible via plain HTTP or over SSLsecured HTTPS. Click on the administrator link to bring up the admin page, which is
secured automatically using SSL with a user name and a password. Use myadmin for user
name and use myadmin for the password.
The admin page demonstrates some RabbitWeb capabilities and provides access to the
HTTP upload page. Click the upload link to bring up the HTTP upload page, which allows
you to choose new files for both the humidity monitor and the admin page. If your browser
prompts you again for your user name and password, they are the same as above.
Note that the upload page is a static page included in the program flash, and can only be
updated by recompiling and downloading the application. This page is protected so that
you cannot accidentally change the upload page, possibly restricting yourself from performing future updates.
To try out the update capability, click the upload link on the admin page and choose a simple text file to replace monitor.ztm. Open another browser window and load the main
page. You will see that your text file has replaced the humidity monitor. To restore the
monitor, go back to the other window, click back to go to the upload page again, and
choose HUMIDITY_MONITOR.ZHTML to replace monitor.ztm and click Upload.
When you refresh the page in your browser, you will see that the page has been restored.
You have successfully updated and restored your application's files remotely!
64
RabbitCore RCM3309/RCM3319
When you are finished with the INTEGRATION.C sample program, you need to follow a
special shutdown procedure before powering off to prevent any possible corruption of the
FAT file system. Press and hold switch S2 on the Prototyping Board until LED DS3 blinks
rapidly to indicate that it is now safe to turn the RCM3309/RCM3319 off. This procedure
can be modified by the user to provide other application-specific shutdown tasks.
6.7 Where Do I Go From Here?
NOTE: If you purchased your RCM3309/RCM3319 through a distributor or through a
Rabbit partner, contact the distributor or partner first for technical support.
If there are any problems at this point:
• Use the Dynamic C Help menu to get further assistance with Dynamic C.
• Check the Rabbit Technical Bulletin Board at
www.rabbit.com/support/bb/.
• Use the Technical Support e-mail form at www.rabbit.com/support/questionSubmit.shtml.
If the sample programs ran fine, you are now ready to go on.
Additional sample programs are described in the Dynamic C TCP/IP User’s Manual.
Please refer to the Dynamic C TCP/IP User’s Manual to develop your own applications.
An Introduction to TCP/IP provides background information on TCP/IP, and is available
on the CD and on our Web site.
User’s Manual
65
66
RabbitCore RCM3309/RCM3319
APPENDIX A. RCM3309/RCM3319
SPECIFICATIONS
Appendix A provides the specifications for the RCM3309/
RCM3319, and describes the conformal coating.
User’s Manual
67
A.1 Electrical and Mechanical Characteristics
Figure A-1 shows the mechanical dimensions for the RCM3309/RCM3319.
1.850
(47.0)
1.375
(34.9)
R15
C1
C4
R10
C8
C9
U5
C3
C7
R7
R8
R9
U3
U4
C10
C11
(69.2)
R20
Q2
RCM39XX
R33
R34
DS2
DS3
DS1
SPD LNK FDX
ACT COL
R32
R29 U10
D1
U9
Q1
C48
R31
C45
R35
C47
JP14
R28
CE
C46
R30
1
C40 R22
C43 U8
2
R25 R26
BSY
JP13
C49
C50
JP11
JP12
C41
C42
R27
R24 Y3
C44 C39
C38
R21
R23
(33.5)
(17.5)
U7 R19
1.320
0.690
C36
C34
2.725
JP9
JP8
JP10
J3
C31
Y2 C30
C29
C37
R18
L1
C33
L2
0.47
C26
C32
R16
(11.9)
R14
C28 C25
R13
C27 C22
C23
R12
U6
JP7
C18
C35
C16
C13
C17
R17 C19 C15
C14
R11
C24 C20
C21
Please refer to the RCM3309
footprint diagram later in this
appendix for precise header
locations.
JP2 JP3 JP4 JP5
R5
R6
C12
(2.5)
J2
R4
Y1 C5
C6
0.100 dia
JP1
U2
J1
C2
R2
R3
R1
U1
DS4
0.17
(4.3)
0.97
(22)
(6.2)
0.245
(2.2)
J3
0.087
(47.0)
(1.6)
1.850
0.063
J4
0.86
(14)
0.55
(24.7)
Figure A-1. RCM3309/RCM3319 Dimensions
NOTE: All measurements are in inches followed by millimeters enclosed in parentheses.
All dimensions have a manufacturing tolerance of ±0.01" (0.25 mm).
68
RabbitCore RCM3309/RCM3319
It is recommended that you allow for an “exclusion zone” of 0.04" (1 mm) around the
RCM3309/RCM3319 in all directions when the RCM3309/RCM3319 is incorporated into
an assembly that includes other printed circuit boards. An “exclusion zone” of 0.08"
(2 mm) is recommended below the RCM3309/RCM3319 when the RCM3309/RCM3319
is plugged into another assembly. Figure A-2 shows this “exclusion zone.”
2.81
(2)
0.08
0.6
(16)
(71.2)
2.725
(69.2)
Exclusion
Zone
1.93
(2)
0.08
0.6
(16)
(49.0)
J62
1.850
J61
(47.0)
Figure A-2. RCM3309/RCM3319 “Exclusion Zone”
NOTE: All measurements are in inches followed by millimeters enclosed in parentheses.
User’s Manual
69
Table A-1 lists the electrical, mechanical, and environmental specifications for the RCM3309/
RCM3319.
Table A-1. RCM3309/RCM3319 Specifications
Parameter
RCM3309
RCM3319
Microprocessor
Low-EMI Rabbit 3000® at 44.2 MHz
EMI Reduction
Spectrum spreader for reduced EMI (radiated emissions)
Ethernet Port
SRAM
10/100Base-T, RJ-45, 3 LEDs
512K program (fast SRAM) + 512K data
Flash Memory
(program)
Memory
(data storage)
512K
8MB
(serial flash)
4MB
(serial flash)
LED Indicators
LINK/ACT (link/activity)
FDX/COL (full-duplex/collisions)
SPEED (on for 100Base-T Ethernet connection)
CE/BSY (serial flash enabled/user-programmable)
Backup Battery
Connection for user-supplied backup battery
(to support RTC and data SRAM)
General-Purpose
I/O
Additional Inputs
Additional
Outputs
Auxiliary I/O Bus
49 parallel digital I/0 lines:
• 43 configurable I/O
• 3 fixed inputs
• 3 fixed outputs
Startup mode (2), reset in
Status, reset out
Can be configured for 8 data lines and
5 address lines (shared with parallel I/O lines), plus I/O read/write
Five 3.3 V, CMOS-compatible ports (shared with I/O)
• all 5 configurable as asynchronous (with IrDA)
Serial Ports
• 3 configurable as clocked serial (SPI)
• 2 configurable as SDLC/HDLC
• 1 asynchronous serial port dedicated for programming
Serial Rate
Slave Interface
Real-Time Clock
Timers
Watchdog/
Supervisor
70
Maximum asynchronous baud rate = CLK/8
A slave port allows the RCM3309/RCM3319 to be used as an
intelligent peripheral device slaved to a master processor, which
may either be another Rabbit 3000 or any other type of processor
Yes
Ten 8-bit timers (6 cascadable, 3 reserved for internal peripherals),
one 10-bit timer with 2 match registers
Yes
RabbitCore RCM3309/RCM3319
Table A-1. RCM3309/RCM3319 Specifications (continued)
Parameter
Pulse-Width
Modulators
RCM3309
RCM3319
4 PWM registers with 10-bit free-running counter
and priority interrupts
Input Capture
2-channel input capture can be used to time input signals from
various port pins
Quadrature
Decoder
2-channel quadrature decoder accepts inputs from external
incremental encoder modules
Power
Operating
Temperature
Humidity
3.15–3.45 V DC
325 mA @ 44.2 MHz, 3.3 V
–40°C to +85°C
5% to 95%, noncondensing
Connectors
Two 2 × 17, 2 mm pitch
One 2 × 5 for programming with 1.27 mm pitch
Board Size
1.850" × 2.725" × 0.86"
(47 mm × 69 mm × 22 mm)
User’s Manual
71
A.1.1 Headers
The RCM3309/RCM3319 uses headers at J61 and J62 for physical connection to other
boards. J61 and J62 are 2 × 17 SMT headers with a 2 mm pin spacing. J1, the programming port, is a 2 × 5 header with a 1.27 mm pin spacing.
(35.7)
1.405
(2.0)
0.079
(28.5)
(30.4)
1.199
(30.6)
1.121
1.205
(26.5)
1.043
(24.2)
0.953
(28.9)
1.136
(8.0)
0.314
(2.0)
0.079
(2.5)
0.100 dia
(34.1)
1.341
(28.6)
1.125
(0.5)
J1
0.020 sq typ
J61
J62
Figure A-3 shows the layout of another board for the RCM3309/RCM3319 to be plugged
into. These values are relative to the mounting hole.
(34.9)
(8.3)
0.328
(0.25)
1.375
0.010
RCM3309/RCM3319
Footprint
0.475
(12.1)
Figure A-3. User Board Footprint for RCM3309/RCM3319
72
RabbitCore RCM3309/RCM3319
A.2 Bus Loading
You must pay careful attention to bus loading when designing an interface to the
RCM3309/RCM3319. This section provides bus loading information for external devices.
Table A-2 lists the capacitance for the various RCM3309/RCM3319 I/O ports.
Table A-2. Capacitance of Rabbit 3000 I/O Ports
I/O Ports
Input
Capacitance
(pF)
Output
Capacitance
(pF)
12
14
Parallel Ports A to G
Table A-3 lists the external capacitive bus loading for the various RCM3309/RCM3319
output ports. Be sure to add the loads for the devices you are using in your custom system
and verify that they do not exceed the values in Table A-3.
Table A-3. External Capacitive Bus Loading -40°C to +85°C
Output Port
All I/O lines with clock
doubler enabled
User’s Manual
Clock Speed
(MHz)
Maximum External
Capacitive Loading (pF)
44.2
100
73
Figure A-4 shows a typical timing diagram for the Rabbit 3000 microprocessor external I/O
read and write cycles.
External I/O Read (one programmed wait state)
T1
Tw
T2
CLK
A[15:0]
valid
Tadr
/CSx
/IOCSx
TCSx
TCSx
TIOCSx
TIOCSx
/IORD
TIORD
TIORD
/BUFEN
TBUFEN
Tsetup
TBUFEN
D[7:0]
valid
Thold
External I/O Write (one programmed wait state)
T1
Tw
T2
CLK
A[15:0]
valid
Tadr
/CSx
/IOCSx
/IOWR
/BUFEN
D[7:0]
TCSx
TCSx
TIOCSx
TIOCSx
TIOWR
TIOWR
TBUFEN
TBUFEN
valid
TDHZV
TDVHZ
Figure A-4. I/O Read and Write Cycles—No Extra Wait States
NOTE: /IOCSx can be programmed to be active low (default) or active high.
74
RabbitCore RCM3309/RCM3319
Table A-4 lists the delays in gross memory access time at 3.3 V.
Table A-4. Data and Clock Delays VIN ±10%, Temp, -40°C–+85°C (maximum)
Clock to Address Output Delay
(ns)
30 pF
60 pF
90 pF
Data Setup
Time Delay
(ns)
6
8
11
1
VIN
3.3 V
Spectrum Spreader Delay
(ns)
Normal
Strong
no dbl/dbl
no dbl/dbl
3/4.5
4.5/9
The measurements are taken at the 50% points under the following conditions.
• T = -40°C to 85°C, V = VDD ±10%
• Internal clock to nonloaded CLK pin delay ≤ 1 ns @ 85°C/3.0 V
The clock to address output delays are similar, and apply to the following delays.
• Tadr, the clock to address delay
• TCSx, the clock to memory chip select delay
• TIOCSx, the clock to I/O chip select delay
• TIORD, the clock to I/O read strobe delay
• TIOWR, the clock to I/O write strobe delay
• TBUFEN, the clock to I/O buffer enable delay
The data setup time delays are similar for both Tsetup and Thold.
When the spectrum spreader is enabled with the clock doubler, every other clock cycle is
shortened (sometimes lengthened) by a maximum amount given in the table above. The
shortening takes place by shortening the high part of the clock. If the doubler is not
enabled, then every clock is shortened during the low part of the clock period. The maximum shortening for a pair of clocks combined is shown in the table.
Technical Note TN227, Interfacing External I/O with Rabbit 2000/3000 Designs, contains suggestions for interfacing I/O devices to the Rabbit 3000 microprocessors.
User’s Manual
75
A.3 Rabbit 3000 DC Characteristics
Table A-5. Rabbit 3000 Absolute Maximum Ratings
Symbol
Parameter
Maximum Rating
TA
Operating Temperature
-55° to +85°C
TS
Storage Temperature
-65° to +150°C
Maximum Input Voltage:
• Oscillator Buffer Input
• 5-V-tolerant I/O
VDD
Maximum Operating Voltage
VDD + 0.5 V
5.5 V
3.6 V
Stresses beyond those listed in Table A-5 may cause permanent damage. The ratings are
stress ratings only, and functional operation of the Rabbit 3000 chip at these or any other
conditions beyond those indicated in this section is not implied. Exposure to the absolute
maximum rating conditions for extended periods may affect the reliability of the Rabbit
3000 chip.
Table A-6 outlines the DC characteristics for the Rabbit 3000 at 3.3 V over the recommended operating temperature range from TA = –55°C to +85°C, VDD = 3.0 V to 3.6 V.
Table A-6. 3.3 Volt DC Characteristics
Symbol
Parameter
Min
Typ
Max
Units
3.3
3.6
V
VDD
Supply Voltage
3.0
VIH
High-Level Input Voltage
2.0
VIL
Low-Level Input Voltage
VOH
High-Level Output Voltage
IOH = 6.8 mA,
VDD = VDD (min)
VOL
Low-Level Output Voltage
IOL = 6.8 mA,
VDD = VDD (min)
IIH
High-Level Input Current
VIN = VDD,
IIL
Low-Level Input Current
IOZ
VIN = VSS,
(absolute worst case, all buffers) VDD = VDD (max)
High-Impedance State
Output Current
V
0.8
0.7 x
VDD
(absolute worst case, all buffers) VDD = VDD (max)
(absolute worst case, all buffers)
76
Test Conditions
VIN = VDD or VSS,
VDD = VDD (max), no pull-up
V
0.4
V
10
µA
-10
-10
V
µA
10
µA
RabbitCore RCM3309/RCM3319
A.4 I/O Buffer Sourcing and Sinking Limit
Unless otherwise specified, the Rabbit I/O buffers are capable of sourcing and sinking
6.8 mA of current per pin at full AC switching speed. Full AC switching assumes a
22.1 MHz CPU clock and capacitive loading on address and data lines of less than 100 pF
per pin. The absolute maximum operating voltage on all I/O is 5.5 V.
Table A-7 shows the AC and DC output drive limits of the parallel I/O buffers when the
Rabbit 3000 is used in the RCM3309/RCM3319.
Table A-7. I/O Buffer Sourcing and Sinking Capability
Output Drive (Full AC Switching)
Pin Name
All data, address, and I/O
lines with clock doubler
enabled
Sourcing/Sinking Limits
(mA)
Sourcing
Sinking
6.8
6.8
Under certain conditions, you can exceed the limits outlined in Table A-7. See the Rabbit
3000 Microprocessor User’s Manual for additional information.
User’s Manual
77
A.5 Jumper Configurations
Figure A-5 shows the jumper locations used to configure the various RCM3309/
RCM3319 options. The black square indicates pin 1.
RCM3309/RCM3319
JP13
JP11
JP12
JP7
JP8
JP9
JP10
JP2
JP3
JP4
JP5
JP1
JP14
Top Side
Figure A-5. Location of RCM3309/RCM3319 Configurable Positions
Table A-8 lists the configuration options.
Table A-8. RCM3309/RCM3319 Jumper Configurations
Header
Description
JP1
Serial Flash Chip Enable Indicator
1–2
ACT or PD1 Output
on J61 pin 34
1–2
ACT
JP2
2–3
PD1
LINK or PD0 Output
on J61 pin 33
1–2
LINK
2–3
PD0
1–2
ENET
2–3
PE0
1–2
Reserved for future use
2–3
PD1 controls NAND Flash
JP3
JP4
JP5
78
ENET or PE0 Output
on J62 pin 19
Pins Connected
Factory
Default
×
×
×
×
NAND Flash Chip Enable
n.c.
RabbitCore RCM3309/RCM3319
Table A-8. RCM3309/RCM3319 Jumper Configurations
Header
JP7
JP8
JP9
JP10
JP11
JP12
JP13
JP14
Description
PD6 or TPI– Input
on J61 pin 31
PD7 or TPI+ Input
on J61 pin 32
PD2 or TPO– Output
on J61 pin 29
PD3 or TPO+ Output
on J61 pin 30
Pins Connected
1–2
TPI–
2–3
PD6
1–2
TPI+
2–3
PD7
1–2
TPO–
2–3
PD2
1–2
TPO+
2–3
PD3
1–2
256K
2–3
512K
1–2
Normal Mode
2–3
Bank Mode
1–2
256K
2–3
512K
1–2
FDX/COL displayed by LED DS1
2–3
Optional ACT displayed by LED
DS1
Factory
Default
Flash Memory Size
Flash Memory Bank Select
Data SRAM Size
LED DS1 Display
×
×
×
×
×
×
×
×
NOTE: The jumper connections are made using 0 Ω surface-mounted resistors.
User’s Manual
79
A.6 Conformal Coating
The areas around the 32 kHz real-time clock crystal oscillator have had the Dow Corning
silicone-based 1-2620 conformal coating applied. The conformally coated area is shown
in Figure A-6. The conformal coating protects these high-impedance circuits from the
effects of moisture and contaminants over time.
Conformally coated
areas
R15
JP2 JP3 JP4 JP5
C1
C4
R10
R9
R8
C7
R7
C8
C9
U4
U5
C3
R5
R6
U3
C10
C11
C26
C32
Y2
C30
JP9
JP8
J3
L2
C31
C34
C37
C29
L1
C33
R16
R18
JP10
C27 C22
C23
R14
C28 C25
R13
C36
R12
U6
R17 C19 C15
C18
JP7
C13
C17
C35
C16
C12
C14
R11
C24 C20
C21
J2
R4
Y1 C5
C6
JP1
U2
J1
C2
R2
R3
R1
U1
U7 R19
R20
Q2
RCM39XX
R33
R34
DS2
DS3
DS1
SPD LNK FDX
ACT COL
R32
R29 U10
D1
U9
Q1
C48
R31
C45
R35
C47
JP14
R28
CE
C46
R30
C40 R22
C43 U8
2
1
BSY
JP13
C49
C50
JP11
JP12
C41
C42
R27
R24 Y3
R25 R26
C44 C39
C38
R21
R23
DS4
Figure A-6. RCM3309/RCM3319 Areas Receiving Conformal Coating
Any components in the conformally coated area may be replaced using standard soldering
procedures for surface-mounted components. A new conformal coating should then be
applied to offer continuing protection against the effects of moisture and contaminants.
NOTE: For more information on conformal coatings, refer to Rabbit’s Technical Note
TN303, Conformal Coatings, in the online documentation.
80
RabbitCore RCM3309/RCM3319
APPENDIX B. PROTOTYPING BOARD
Appendix B describes the features and accessories of the Prototyping Board.
User’s Manual
81
B.1 Introduction
The Prototyping Board included in the Development Kit makes it easy to connect an
RCM3309/RCM3319 module to a power supply and a PC workstation for development. It
also provides some basic I/O peripherals (RS-232, RS-485, a relay, LEDs, and switches),
as well as a prototyping area for more advanced hardware development.
For the most basic level of evaluation and development, the Prototyping Board can be
used without modification.
As you progress to more sophisticated experimentation and hardware development, modifications and additions can be made to the board without modifying or damaging the
RCM3309/RCM3319 module itself.
The Prototyping Board is shown below in Figure B-1, with its main features identified.
Quadrature
Decoder
Terminals
C7
R62
R54
R59
R51
R3
R4
R5
R6
R7
R2
R63
R64
R65
R66
R55
R56
R57
R58
OUT 00 01 02 03 04 05 06 07
Through-Hole
Prototyping Area
U5
R16
R15
R20
C13
RP2
J11
BT1
R19
RP1
U4
SERIAL FLASH/
MODEM
C14
C15
OUT
RCM3300
PROTOTYPING
BOARD
GND
Q3
Q4
J12
R50
D4
Q6
R49
Reset
Switch
S3
CORE
D5
D6
D7
J14
R36
C22
C23
C24
JP5
C26
RELAY RATED
0.5 A @ 30 V
BD7
BD6
BD5
BD4
BD3
BD2
BD1
BA3
BA2
BA1
BD0
LCD
/CS
BA0
D6
D2
D4
D0
D3
GND
GND
D1
LED6
GND
A1
LED4
A3
LED2
A0
LED0
LED5
A2
/RES
/CS
LED3
U11
D5
D7
C27
C28
R43
R44
C20
R41
U12
D8
R35
R38
K E Y PA D D I S P L AY B O A R D
LCD1JB
DS2 DS3 DS4 DS5 DS6
C29
C30
Q5
R47
Relay
Terminals
LCD1JC
TxE RxE GND TxF RxF 485+ GND 485
{
{
S2
U9
J13
JB
R46
R27 R28
J9
S1
RESET
K1
R45
Q2
J17
R42
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
R25 R26
Q1
C19
R48
GND
STAT
R40
U10
JA
LED1
PA7
UX2
SO20W
+V
PA6
R21 R22 R23 R24
+BKLT
PA5
SOT23-6
PA3
PA4
SOT23-6
PA1
PA2
DX2
C18
PF3
PA0
UX5
CX2
C16
R37
PF2
SMT Prototyping
Area
U8
C17
PF1
J16
LCD1JA
{
PC0
PF0
R33
R34
PC2
PC1
+3.3 V
R39 J15
RX18
UX4
DX1
C25
PC4
PC3
C21
PC6
PC5
RX17
RX15
UX1
SO20W
HO1
PC7
RX16
RX14
CX1
R32
PG0
HO2
PG2
HO3
PD4
HO4
PD2
PD5
PG1
RX13
GND
PD3
PG3
GND
+3.3 V
R30
PD6
R31
PD7
GND/EGND
R29
LINK
{
ACT
+5 V, 3.3 V, and
GND Buses
+5 V
+5 V
CORE MODULE
Module
Extension Header
C5
J10
JP4
C8
RABBITNET
R8 U6 C6
R9
R14
Serial Flash
Socket
U7
R18
/RES_OUT
R60 R61
U3
L293D
H-DRIVER
C4
R13
R52 R53
R17
PB2
PB0
C10
C11
PB4
PB3
C9
PB6
PB5
R67
R68
R69
R70
C12
PF4 PF6 PE7
R12
PB7
U2
L293D
H-DRIVER
U1
PF0_QD
R10
R11
L1
PF5
PF7
JP1
PE5
C3
JP2
PE3
PE4
C2
D2
JP3
GND
+DC
+DC
GND
J1
J2
PE0
PE1
J3
PG6
PG7
DS1
GND
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
PG5
+5V QD2A QD2B QD1A QD1B GND J5
PG4
+5V
/IORD
/IOWR
PF0_CLKD
C1
SMODE1
IN0
VRAM
SM0
IN1
VBT
/RES
IN2
+3.3 V
PE6
RCM3309/RCM3319
Module
Connectors
D1
NC
GND
GND IN3
Voltage
Regulators
R1
J8
GND
J6
Module
Extension Header
Digital RabbitNet
Port
Inputs
{
{
{
H-Bridge
Motor Driver
Terminals
Power
LED
J7
Power
Input
User RS-232
LEDs Signals
User
Switches
Core
LED
RS-485
LCD/Keypad
Module
Connections
Relay User
LED
Figure B-1. Prototyping Board
82
RabbitCore RCM3309/RCM3319
B.1.1 Prototyping Board Features
• Power Connection—A power-supply jack and a 3-pin header are provided for connection to the power supply. Note that the 3-pin header is symmetrical, with both outer
pins connected to ground and the center pin connected to the raw V+ input. The cable
of the AC adapter provided with Development Kit ends in a 3-pin plug that connects to
the 3-pin header (J2)—the center pin of J2 is always connected to the positive terminal,
and either edge pin is negative.
Users providing their own power supply should ensure that it delivers 8–30 V DC at 1 A.
• Regulated Power Supply—The raw DC voltage provided at the POWER IN jack is
routed to a 5 V switching voltage regulator, then to a separate 3.3 V linear regulator.
The regulators provide stable power to the RCM3309/RCM3319 module and the Prototyping Board. The voltage regulators will get warm while in use.
• Power LED—The power LED lights whenever power is connected to the Prototyping
Board.
• Core LED—The core LED lights whenever an RCM3309/RCM3319 module is
plugged in correctly on the Prototyping Board and the RCM3309/RCM3319 module is
not being reset.
• Relay LED—The relay LED lights whenever the Prototyping Board relay is energized.
• Reset Switch—A momentary-contact, normally open switch is connected directly to the
RCM3309/RCM3319’s /RESET_IN pin. Pressing the switch forces a hardware reset of
the system.
• I/O Switches and LEDs—Two momentary-contact, normally open switches are connected to the PG0 and PG1 pins of the RCM3309/RCM3319 module and may be read
as inputs by sample applications.
Four user LEDs (DS3–DS6) are connected to alternate I/O bus pins PA0–PA3 pins of
the RCM3309/RCM3319 module via U8, and may be driven as output indicators. PE7
and PG5 control the registers in U8 as shown in the sample applications.
• Prototyping Area—A generous prototyping area has been provided for the installation
of through-hole components. +3.3 V, +5 V, and Ground buses run along one edge of
this area. Several areas for surface-mount devices are also available. Each SMT pad is
connected to a hole designed to accept a 30 AWG solid wire.
• LCD/Keypad Module—Rabbit’s LCD/keypad module may be plugged in directly to
headers LCD1JA, LCD1JB, and LCD1JC. The signals on headers LCD1JB and
LCD1JC will be available only if the LCD/keypad module is plugged in to header
LCD1JA. Appendix C provides complete information for mounting and using the
LCD/keypad module.
User’s Manual
83
• Module Extension Headers—The complete pin set of the RCM3309/RCM3319
module is duplicated at headers J8 and J9. Developers can solder wires directly into the
appropriate holes, or, for more flexible development, 2 × 17 header strips with a 0.1"
pitch can be soldered into place. See Figure B-4 for the header pinouts.
• Digital I/O—Four digital inputs are available on screw-terminal header J6. See
Figure B-4 for the header pinouts.
• RS-232—Two 3-wire serial ports or one 5-wire RS-232 serial port are available on the
Prototyping Board at screw-terminal header J14.
• RS-485—One RS-485 serial port is available on the Prototyping Board at screw-terminal header J14.
• Quadrature Decoder—Four quadrature decoder inputs (PF0–PF3) from the Rabbit
3000 chip are available on screw-terminal header J5. See Figure B-4 for the header
pinouts.
• H-Bridge Motor Driver—Two pairs of H-bridge motor drivers are supported using
screw-terminal headers J3 and J4 on the Prototyping Board for stepper-motor control.
See Figure B-4 for the header pinouts.
• RabbitNet Port—One RS-422 RabbitNet port (shared with the serial flash interface) is
available to allow RabbitNet peripheral cards to be used with the Prototyping Board.
• Serial Flash Interface—One serial flash interface (shared with the RabbitNet port) is
available to allow Rabbit’s SF1000 series serial flash to be used on the Prototyping
Board.
84
RabbitCore RCM3309/RCM3319
B.2 Mechanical Dimensions and Layout
C7
R62
R59
R54
R51
R3
R4
R5
R6
R7
R2
R63
R64
R65
R66
R55
R56
R57
R58
R10
OUT
JP4
RP1
RP2
J11
BT1
Battery
C13
U4
U5
R16
SERIAL FLASH/
MODEM
J10
OUT 00 01 02 03 04 05 06 07
R20
/RES_OUT
C5
R19
PB0
R9
R14
RABBITNET
R8 U6 C6
U3
L293D
H-DRIVER
C4
U7
R18
PB2
C8
PF0_QD
R60 R61
C14
C15
PB3
R67
R68
R69
R70
U2
R17
PB4
C12
PB6
C9
PF5
PB5
R13
U1
R12
PB7
PF7
L293D
H-DRIVER
C10
C11
PE5
PE6
PF4 PF6 PE7
PE4
D2
L1
R11
PE3
JP1
PE0
PE1
C3
JP2
PG6
PG7
J3
PG5
C2
R52 R53
JP3
GND
+DC
GND
J1
J2
PG4
DS1
+DC
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
/IORD
+5V QD2A QD2B QD1A QD1B GND J5
SM0
+5V
SMODE1
/IOWR
PF0_CLKD
C1
/RES
IN0
VRAM
IN1
+3.3 V
VBT
IN2
GND
GND IN3
D1
NC
J6
R1
J8
GND
J7
GND
Figure B-2 shows the mechanical dimensions and layout for the Prototyping Board.
R15
5.25
(133)
RCM3300
PROTOTYPING
BOARD
+5 V
+5 V
GND
CORE MODULE
Q6
R49
S2
S3
CORE
D5
D6
D7
DS2 DS3 DS4 DS5 DS6
J14
C23
C24
JP5
C26
RELAY RATED
0.5 A @ 30 V
BD7
BD6
BD5
BD4
BD3
BD2
BA3
BD1
BD0
BA2
BA1
BA0
D6
D4
D2
GND
D0
LED6
GND
A1
LED4
GND
A3
LED2
LED5
R43
C30
R44
C20
D5
D3
A0
A2
D1
D7
C29
U12
D8
R38
K E Y PA D D I S P L AY B O A R D
Q5
R47
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
D4
R36
C22
LED3
U11
R35
R46
J12
R50
U9
J13
JB
R41
K1
R48
Q4
J17
R42
R45
R27 R28
Q3
C19
C27
R25 R26
Q2
J9
S1
RESET
R40
C28
GND
STAT
LCD
/CS
PA7
Q1
LED0
PA6
LCD1JA
U10
JA
/RES
PA5
UX2
SO20W
+V
PA3
PA4
C16
R21 R22 R23 R24
/CS
PA1
PA2
DX2
J16
LED1
PA0
UX5
CX2
R39 J15
+BKLT
PF3
SOT23-6
PF1
PF2
DX1
SOT23-6
PC0
PF0
UX1
SO20W
U8
+3.3 V
R37
PC1
UX4
C18
PC2
RX18
C17
PC3
RX16
RX17
R33
R34
PC4
RX13
RX14
RX15
C25
PC6
PC5
C21
PG0
PC7
HO1
PG1
HO2
PG2
R32
PG3
CX1
R31
PD4
HO3
PD2
PD5
HO4
PD6
PD3
GND
PD7
GND
+3.3 V
R30
LINK
R29
ACT
GND/EGND
LCD1JB
LCD1JC
TxE RxE GND TxF RxF 485+ GND 485
6.75
(171)
Figure B-2. Prototyping Board Dimensions
NOTE: All measurements are in inches followed by millimeters enclosed in parentheses.
User’s Manual
85
Table B-1 lists the electrical, mechanical, and environmental specifications for the Prototyping Board.
Table B-1. Prototyping Board Specifications
Parameter
Specification
Board Size
5.25" × 6.75" × 1.00" (133 mm × 171 mm × 25 mm)
Operating Temperature
–20°C to +70°C
Humidity
5% to 95%, noncondensing
Input Voltage
8 V to 30 V DC
Maximum Current Draw
800 mA max. for +3.3 V supply,
(including user-added circuits) 1 A total +3.3 V and +5 V combined
Backup Battery
CR2032, 3 V lithium coin-type
4 inputs pulled up, ± 36 V DC,
switching threshold 0.9–2.3 V typical
Digital Inputs
4 sinking outputs,+30 V DC, 500 mA maximum per channel
8 CMOS-level outputs if stepper motor not installed
Digital Outputs
Relay
SPDT relay, 500 mA @ 30 V
Serial Ports
• two 3-wire RS-232 or one RS-232 with RTS/CTS
• one RS-485
Other Serial Interfaces
RabbitNet RS-422 port or SF1000 serial flash interface
Other Interfaces
• stepper motor control
• quadrature decoder
• LCD/keypad module
Seven LEDs
LEDs
Prototyping Area
•
•
•
•
one power on indicator
one RCM3309/RCM3319 module indicator
four user-configurable LEDs
one relay indicator
Throughhole, 0.1" spacing, additional space for SMT
components
• two 2 × 17, 2 mm pitch sockets for RCM3309/RCM3319
module
Connectors
• one 2 × 5, 2 mm pitch socket for SF1000 serial flash module
• six screw-terminal headers for serial ports, digital inputs,
stepper motor control, quadrature decoder, and relay
contacts
• one RJ-45 RabbitNet jack
Standoffs/Spacers
86
7, accept 4-40 x 1/2 screws
RabbitCore RCM3309/RCM3319
B.3 Power Supply
The RCM3309/RCM3319 requires a regulated 3.15 V to 3.45 V DC power source to operate. Depending on the amount of current required by the application, different regulators
can be used to supply this voltage.
The Prototyping Board has an onboard +5 V switching power regulator from which a
+3.3 V linear regulator draws its supply. Thus both +5 V and +3.3 V are available on the
Prototyping Board.
The Prototyping Board itself is protected against reverse polarity by a diode at D1 as
shown in Figure B-3.
SWITCHING POWER REGULATOR
POWER
IN
J4
1
2
3
D1
DCIN
DL4003
C1
47 µF
+5 V
LINEAR POWER
REGULATOR +3.3 V
3
U1
330 µH
LM2575
330 µF
10 µF
LM1117
U4
1
2
10 µF
L1
D2
1N5819
Figure B-3. Prototyping Board Power Supply
User’s Manual
87
B.4 Using the Prototyping Board
The Prototyping Board is actually both a demonstration board and a prototyping board. As
a demonstration board, it can be used with the sample programs to demonstrate the functionality of the RCM3309/RCM3319 right out of the box without any modifications.
The Prototyping Board pinouts are shown in Figure B-4.
GND
IN3
IN2
IN1
IN0
+5 V
+5 v
QD2A
QD2B
QD1A
GND
VMB
MDB1
MDB2
MDB3
MDB4
VMA+
VMB+
MDA1
MDA2
MDA3
DS1
GND
Digital
Inputs
J5
J6
J7
J11
J10
PC1_RxD
PF0_CLK_RES
PD3_RNET_/RTS
PD6_/CTRL
PD5_/CTS
LCD_/CS
BA0
BA1
BA2
BA3
BD0
BD1
BD2
BD3
BD4
BD5
BD6
BD7
OUT00
OUT01
OUT02
OUT03
OUT04
OUT05
OUT06
OUT07
GND
VCC
PC0_TxD
PD2_CE
PD4_DCD
J15
J16
J17
NC2
COM2
NO2
NO1
RS-232
DS7
RELAY
LED
485
GND
J14
485+
User
LEDs
RELAY
CONTACTS
COM1
PB0
PC5
PC4
RxF
DS2 DS3 DS4 DS5 DS6
Core
LED
NC1
TxF
Digital
Outputs
(sinking)
J13
GND
J12
RxE
LINK
PD6
PD2
PD4
PG2
PG0
PC6
PC4
PC2
PC0
PF1
PF3
PA1
PA3
PA5
PA7
GND
J4
TxE
J9
J3
GND
HOUT4
HOUT3
HOUT2
HOUT1
ACT
PD7
PD3
PD5
PG3
PG1
PC7
PC5
PC3
PC1
PF0
PF2
PA0
PA2
PA4
PA6
STATUS
n.c.
+3.3 V
VRAM
SMODE1
/IORD
PG4
PG6
PE0
PE3
PE5
PE7
PF6
PF4
PB6
PB4
PB2
/RES_OUT
MDA4
VMA
J2
J8
GND
GND
VBT
/RES
SMODE0
/IOWR
PG5
PG7
PE1
PE4
PE6
PF7
PF5
PB7
PB5
PB3
PB0
+DC
J1
GND
Power
QD1B
Quadrature
Decoder
Stepper-Motor
Control
RS-485
Figure B-4. Prototyping Board Pinout
88
RabbitCore RCM3309/RCM3319
The Prototyping Board comes with the basic components necessary to demonstrate the
operation of the RCM3309/RCM3319. Four user LEDs (DS3–DS6) are connected to
alternate I/O bus pins PA0–PA3 pins of the RCM3309/RCM3319 module via U8, and may
be driven as output indicators when controlled by PE7 and PG5 as shown in the sample
applications. Two switches (S2 and S3) are connected to PG0 and PG1 to demonstrate the
interface to the Rabbit 3000 microprocessor. Reset switch S1 is the hardware reset for the
RCM3309/RCM3319.
The Prototyping Board provides the user with RCM3309/RCM3319 connection points
brought out conveniently to labeled points at J8 and J9 on the Prototyping Board. Although
locations J8 and J9 are unstuffed, 2 × 17 headers are included in the bag of parts.
RS-232 and RS-485 signals are available on screw-terminal header J14, quadrature decoder
inputs are available on screw-terminal header J5, and digital inputs are available on screwterminal header J6. A 1 × 5 header strip from the bag of parts may be installed at J12 for four
sinking digital outputs. The clocked Serial Port B signals from the RCM3309/RCM3319
are used for the serial flash, and cannot be accessed via header J13 on the Prototyping
Board.
If you don’t plan to use the LCD/keypad module, additional signals may be brought out on 1 × 5
and 1 × 8 headers from the bag of parts that you install at J15 and J16. If you don’t plan to use
the stepper-motor control option, additional CMOS outputs are available via a 1 × 8 header
that you install at J10.
There is a through-hole prototyping space available on the Prototyping Board. The holes in
the prototyping area are spaced at 0.1" (2.5 mm). +3.3 V, +5 V, and GND traces run along
one edges of the prototyping area. Small to medium circuits can be prototyped using pointto-point wiring with 20 to 30 AWG wire between the prototyping area, the +3.3 V, +5 V, and
GND traces, and the surrounding area where surface-mount components may be installed.
Small holes are provided around the surface-mounted components that may be installed
around the prototyping area.
B.4.1 Adding Other Components
There are two sets of pads for 6-pin, 16-pin, and 28-pin devices that can be used for surface-mount prototyping devices. There are also pads that can be used for SMT resistors
and capacitors in an 0805 SMT package. Each component has every one of its pin pads
connected to a hole in which a 30 AWG wire can be soldered (standard wire wrap wire can
be soldered in for point-to-point wiring on the Prototyping Board). Because the traces are
very thin, carefully determine which set of holes is connected to which surface-mount pad.
User’s Manual
89
B.4.2 Digital I/O
B.4.2.1 Digital Inputs
The Prototyping Board has four digital inputs, IN0–IN3, each of which is protected over a
range of –36 V to +36 V. The inputs are pulled up to +3.3 V as shown in Figure B-5.
JP6
+3.3 V
27 kW
®
22 kW
GND
Figure B-5. Prototyping Board Digital Inputs
The four quadrature decoder inputs on screw-terminal header J5 may be used as inputs
IN4–IN7. To use the PF0 signal from the Rabbit microprocessor, which goes to QD1B,
remember to reconfigure the jumper on header JP3 to jumper pins 1–2.
The actual switching threshold is between 0.9 V and 2.3 V. Anything below this value is a
logic 0, and anything above is a logic 1.
The digital inputs are each fully protected over a range of -36 V to +36 V, and can handle
short spikes of ±40 V.
90
RabbitCore RCM3309/RCM3319
B.4.3 CMOS Digital Outputs
If the stepper-motor option is not used, eight CMOS-level digital outputs are available at
J10, and can each handle up to 25 mA.
B.4.4 Sinking Digital Outputs
Four sinking digital outputs shared with LEDs DS3–DS6 are available at J12, and can each
handle up to 500 mA. Figure B-6 shows a wiring diagram for a typical sinking output.
Vcc
ADD DIODE
WHEN LOAD
IS INDUCTIVE
330 W
1 kW
Figure B-6. Prototyping Board Sinking Digital Outputs
B.4.5 Relay Outputs
Figure B-7 shows the contact connections for the relay on the Prototyping Board. A diode
across the coil provides a return path for inductive spikes, and snubbers across the relay
contacts protect the relay contacts from inductive spikes.
1
3
4
5
6
J17
+3.3 V
1
®
2
10
8
COM1
7
NO1
47 W
100 nF
9
NC1
3
COM2
47 W
4
NO2
47 W
100 nF
100 nF
2
NC2
47 W
100 nF
Figure B-7. Prototyping Board Relay Output Contact Connections
The relay is driven by pin PA4 of the RCM3309/RCM3319 module via U8, and is controlled by PE7 and PG5 as shown in the sample applications.
User’s Manual
91
B.4.6 Serial Communication
The Prototyping Board allows you to access four of the serial ports from the RCM3309/
RCM3319 module. Table B-2 summarizes the configuration options.
Table B-2. Prototyping Board Serial Port Configurations
Serial Port
Signal Header
Configured via
Default Use
Alternate Use
C
J14
JP5*
RS-485
—
RabbitNet
(PD2 = 1)
J7
D
JP3
SF1000
(PD2 = 0)
J11
Rabbit 3000
quadrature decoder
E
J14
—
RS-232
—
F
J14
—
RS-232
—
* RS-485 termination and bias resistors are configured via header JP5.
Serial Port D is configured in software either to allow J7 to be used as a RabbitNet port or
to allow J11 to be used as a serial interface for the SF1000 serial flash.
92
RabbitCore RCM3309/RCM3319
B.4.6.1 RS-232
RS-232 serial communication on the Prototyping Board is supported by an RS-232 transceiver installed at U9. This transceiver provides the voltage output, slew rate, and input
voltage immunity required to meet the RS-232 serial communication protocol. Basically,
the chip translates the Rabbit 3000’s signals to RS-232 signal levels. Note that the polarity
is reversed in an RS-232 circuit so that a +5 V output becomes approximately -10 V and 0
V is output as +10 V. The RS-232 transceiver also provides the proper line loading for
reliable communication.
RS-232 can be used effectively at the RCM3309/RCM3319 module’s maximum baud rate
for distances of up to 15 m.
RS-232 flow control on an RS-232 port is initiated in software using the
serXflowcontrolOn() function call from LIB\RS232.LIB, where X is the serial port
(E or F). The locations of the flow control lines are specified using a set of five macros.
SERX_RTS_PORT—Data register for the parallel port that the RTS line is on (e.g., PGDR).
SERX_RTS_SHADOW—Shadow register for the RTS line's parallel port (e.g., PGDRShadow).
SERX_RTS_BIT—The bit number for the RTS line.
SERX_CTS_PORT—Data register for the parallel port that the CTS line is on (e.g., PCDRShadow).
SERX_CTS_BIT—The bit number for the CTS line.
Standard 3-wire RS-232 communication using Serial Ports E and F is illustrated in the following sample code.
#define EINBUFSIZE 15
#define EOUTBUFSIZE 15
// set size of circular buffers in bytes
#define FINBUFSIZE 15
#define FOUTBUFSIZE 15
#define MYBAUD 115200
#endif
main(){
serEopen(_MYBAUD);
serFopen(_MYBAUD);
serEwrFlush();
serErdFlush();
serFwrFlush();
serFrdFlush();
serEclose(_MYBAUD);
serFclose(_MYBAUD);
}
User’s Manual
// set baud rate
// open Serial Ports E and F
// flush their input and transmit buffers
// close Serial Ports C and D
93
B.4.6.2 RS-485
The Prototyping Board has one RS-485 serial channel, which is connected to the Rabbit
3000 Serial Port C through an RS-485 transceiver. The half-duplex communication uses
an output from PD7 on the Rabbit 3000 to control the transmit enable on the communication line. Using this scheme a strict master/slave relationship must exist between devices
to insure that no two devices attempt to drive the bus simultaneously.
Serial Port C is configured in software for RS-485 as follows.
#define
#define
#define
#define
#define
#define
ser485open serCopen
ser485close serCclose
ser485wrFlush serCwrFlush
ser485rdFlush serCrdFlush
ser485putc serCputc
ser485getc serCgetc
#define CINBUFSIZE 15
#define COUTBUFSIZE 15
#ifndef _485BAUD
#define _485BAUD 115200
#endif
The configuration shown above is based on circular buffers. RS-485 configuration may
also be done using functions from the LIB\PACKET.LIB library.
GND
RS485+
RS-485
GND
RS485+
RS-485
GND
RS485+
RS-485
The Prototyping Boards with RCM3309/RCM3319 modules installed can be used in an
RS-485 multidrop network spanning up to 1200 m (4000 ft), and there can be as many as
32 attached devices. Connect the 485+ to 485+ and 485– to 485– using single twisted-pair
wires as shown in Figure B-8. Note that a common ground is recommended.
Figure B-8. Multidrop Network
94
RabbitCore RCM3309/RCM3319
DS1
J2
C7
R62
R59
R54
R3
R4
R5
R6
R7
R2
R63
R64
R65
R66
R55
R56
R57
R58
C14
C15
SERIAL FLASH/
MODEM
R20
R19
R18
C13
R17
JP4
C12
C10
C11
C9
R10
R11
R15
JP13
R27
R28
JP14
C46
2
C44 C39
1
R25 R26
R23
DS3
DS2
R34
Q1
R33
DS1
C40 R22
C43 U8
R30
C47
R24 Y3
DS4
R32
C48
R31
SPD LNK FDX
ACT COL
R35
R16
JP11
CE
BSY
Q2
PF4 PF6 PE7
RP2
RP1
J11
BT1
U5
JP12
/RES_OUT
RCM3300
PROTOTYPING
BOARD
C5
OUT
U4
RABBITNET
R8 U6 C6
J10
C49
C50
PB2
PB0
C8
U7
C41
C42
R67
R68
R69
R70
RCM39XX
PB4
PB3
R60 R61
R9
R14
OUT 00 01 02 03 04 05 06 07
D1
PB6
PB5
R52 R53
U3
L293D
H-DRIVER
C4
R13
U1
R12
R29 U10
PF5
PB7
PF7
U2
L293D
H-DRIVER
U9
PE5
PE6
L1
C45
PE4
JP1
PE3
JP2
PE0
PE1
J3
PG6
PG7
C3
R51
J1
PG5
C2
D2
PF0_QD
JP3
+DC
+DC
GND
GND
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
PG4
+5V QD2A QD2B QD1A QD1B GND J5
/IORD
+5V
SM0
/IOWR
PF0_CLKD
C1
SMODE1
IN0
VRAM
IN1
+3.3 V
VBT
IN2
GND
/RES
GND IN3
D1
NC
J6
R1
J8
GND
J7
GND
The Prototyping Board comes with a 220 Ω termination resistor and two 681 Ω bias resistors installed and enabled with jumpers across pins 1–2 and 5–6 on header JP5, as shown
in Figure B-9.
C38
R21
R20
J14
JP5
C26
R37
681 W
bias
485
K E Y PA D D I S P L AY B O A R D
C29
R38
220 W
R44
R43
termination
C28
C27
D4
D2
D6
D7
D5
D3
A0
A2
D0
A1
A3
GND
GND
D1
LED6
C20
5
D8
R38
RELAY RATED
0.5 A @ 30 V
BD7
BD6
BD5
BD4
BD3
BD2
BA3
BD1
BD0
BA2
LCD
/CS
BA1
BA0
LED4
GND
LED2
LED5
+V
+BKLT
6
J17
1
C30
Q5
R46
JP1
DS2 DS3 DS4 DS5 DS6
C23
C24
7
R36
681 W
bias
R47
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
R32
HO1
R30
HO2
D7
C22
U12
JP5
K1
U11
R35
R36
2
R42
R48
U2
D6
R31
HO3
C17
JP2 JP3 JP4 JP5
R15
U1
D5
U9
J13
6
C19
R45
J1
HO4
R40
U10
R2
GND
R33
R34
R5
R6
C11
C10
R4
R29
SOT23-6
U3
JB
LCD1JA
R37
C8
C9
U4
J2
S3
UX2
SO20W
C25
L1
S2
CORE
DX2
C18
Y1 C5
D4
R49
SOT23-6
C18
C13
R11
R50
Q6
S1
RESET
U10
C17
J12
CX2
C21
J3
C33
Q4
UX5
LED3
L2
R14
Q3
DX1
J16
+3.3
V
485+
R41
R13
R12
C26
C32
J9
LED0
C31
R27 R28
/RES
C34
C30
Y2
R16
6
R25 R26
UX1
SO20W
+3.3 V
R39 J15
RX18
UX4
/CS
R18
C29
GND
Q2
R1
PA7
Q1
RX17
RX15
R3
PA6
STAT
JA
RX16
RX14
CX1
C12
PA5
RX13
C16
PA3
PA4
C16
R21 R22 R23 R24
C1
PA1
PA2
GND
+3.3 V
C6
PA0
C24 C20
C21
PF3
C28 C25U
PF1
PF2
C2
PF0
R8
PC0
C7
R7
PC2
PC1
U8
C4
PC3
GND
C3
PC4
R10
PC6
PC5
R9
PG0
PC7
U5
PG1
C14
PG2
R17 C19 C15
PD4
PG3
JP7
PD2
PD5
C27 C22
C23
PD6
PD3
JP9
PD7
GND/EGND
JP8
LINK
JP10
ACT
+5 V
+5 V
LED1
U7 R19
C37
C36
C35
CORE MODULE
LCD1JB
LCD1JC
TxE RxE GND TxF RxF 485+ GND 485
Factory
Default
2
4
6
1
3
5
JP5
Figure B-9. RS-485 Termination and Bias Resistors
For best performance, the termination resistors in a multidrop network should be enabled
only on the end nodes of the network, but not on the intervening nodes. Jumpers on boards
whose termination resistors are not enabled may be stored across pins 1–3 and 4–6 of
header JP5.
B.4.7 RabbitNet Ports
The RJ-45 jack labeled RabbitNet is a clocked SPI RS-422 serial I/O expansion port for
use with RabbitNet peripheral boards. The RabbitNet jack does not support Ethernet connections. Header JP3 must have pins 2–3 jumpered when using the RabbitNet port.
The RabbitNet port is enabled in software by setting PD2 = 1. Note that the RabbitNet
port and the J11 interface cannot be used simultaneously.
User’s Manual
95
B.4.8 Other Prototyping Board Modules
An optional LCD/keypad module is available that can be mounted on the Prototyping
Board. The signals on headers LCD1JB and LCD1JC will be available only if the LCD/
keypad module is installed. Refer to Appendix C, “LCD/Keypad Module,” for complete
information.
Rabbit’s SF1000 series serial flash may be installed in the socket labeled J11. The J11
interface is enabled in software by setting PD2 = 0. Header JP3 must have pins 2–3 jumpered when using the J11 interface. Note that the RabbitNet port and the J11 interface cannot be used simultaneously.
B.4.9 Quadrature Decoder
Four quadrature decoder inputs are available on screw-terminal header J5. To use the PF0
input from the Rabbit microprocessor, which goes to the QD1B input, remember to reconfigure the jumper on header JP3 to jumper pins 1–2.
Additional information on the use of the quadrature decoders on Parallel Port F is provided in the Rabbit 3000 Microprocessor User’s Manual.
B.4.10 Stepper-Motor Control
The Prototyping Board can be used to demonstrate the use of the RCM3309/RCM3319 to
control a stepper motor. Stepper motor control typically directs moves in two orthogonal
directions, and so two sets of stepper-motor control circuits are provided for via screwterminal headers J3 and J4.
DS1
C7
R62
R6
R7
R2
R3
R4
R5
C14
C15
SER
MO IAL FL
DEM ASH
/
R10
R19
DS4
RCM39XX
U9
Q2
D1
R28
C45
R29 U10
R27
C43
C47
R15
U8
JP14
C46
1
C39
C38
R23
DS2
R34
Q1
R33
DS1
R22
R25 R26
C44
C40
2
R30
R24 Y3
DS3
8
JP13
R31C4
R32
R35
LN
ACKT FD
COX
L
R16
J11
R20
R51
JP3
BT1
R18
C13
07
R17
C10
C11
C12
06
C41
C42
C9
R57
R58
JP1
04 05
RP2
C49
C50
BSY
U5
RABBITNET
R8 U6 C6
R9
C5
OUT
02 03
RP1
JP4
R55
R56
JP2
R11
R59
+DC
J1
GND
PF6
U7
R63
R64
R65
R66
D
J2
01
R14
R60 R61
JP11
JP12
U4
PF0_QD
U3
L293D
H-DRIVER
C4
R52 R53
R54
J3
D
POWER
GN
VMA+ MDA1 MDA2 MDA3 MDA4 VMA
GN
VMB MDB1 MDB2 MDB3 MDB4 VMB+
PE7
J4
PF4
J5
U2
R13
J10
OUT 00
C8
CE
PB2
/RES_OUT
+5V QD2A QD2B QD1A QD1B GND
U1
R12
R67
R68
R69
R70
SPD
PB3
C3
L293D
H-DRIVER
PE5
PB6
PB4
+5V
PE4
PE6
PF7
IN0
L1
PE0
PF5
RCM3300
PROTOTYPING
BOARD
PF0_CLKD
C2
PE3
PB7
PB5
IN1
PG6
IN2
PG5
PE1
IN3
PG4
PG7
R1
C1
D2
GND
/IOWR
PB0
D1
NC
+3.3 V
VRAM
SMODE1
/IORD
J6
J8
GND
GND
VBT
/RES
SM0
J7
+DC
In order to use the stepper-motor control, install two Texas Instruments L293DN chips at
locations U2 and U3 (shown in Figure B-10). These chips are readily available from your
favorite electronics parts source, and may be purchased through Rabbit’s Web store as part
number 660-0205.
R21
R20
U7 R19
C37
REL
A
0.5 Y RAT
A @ ED
30 V
D6
D4
D2
A1
D0
A3
A0
D1
R48
R47
R44
C28
C27
C30
Q5
R46
C29
NO
1C
OM
1N
C1
NO
2C
OM
2N
C2
D7
D5
D3
D
GN
D
K E Y PA D D I S P L AY B O A R D
D
RESLA7
Y
R38
BD7
BD6
BD5
BD4
BD3
BD2
BD1
BA3
BD0
LC
/CSD
BA2
BA0
BA1
GN
LED6
LED4
LED2
A2
LED0
/RES
D
R43
C18
C17
+V
D8
R35
R45
HO1
HO2
HO3
HO4
R31
U12
R37
U2
JP1
R15
GND
R33
R34
J1
R2
U1
C21
C11
C10
R30
C25
L1
JP2 JP3 JP4 JP5
R32
TxF
C20
R5
R6
R4
RxE GND
J17
R42
K1
U11
U10
LCD1JB
TxE
GN
U3
DS3 DS4 DS5 DS6
/CS
C8
C9
U4
C5
R29
JP5
C26
LED5
C18
Y1
R36
C22
C23
C24
C19
LED3
C33
R11
U9
J13
J14
R40
LED1
J3
C26
C32
C13
D7
J16
LCD1JA
R41
L2
R16
R14
J2
DS2
D6
+3.3 V
R39 J15
+BKL
T
C31
R13
CORE
D5
SO
T23
-6
C34
C30
Y2
R12
S3
JB
D4
SO
T23
-6
C29
Q4
J12
C6
R49
S2
U6
C17
C12
Q3
R50
Q6
C1
Q2
R28
DX2
UX2
SO20W
R1
R27
UX4
UX5
R3
R26
RX16
RX17
RX18
DX1
CX2
C2
Q1
JA
R25
RX13
UX1
SO20W
C3
R10 C4
R9
R8
PA3
PA5
J9
C7
R7
U5
R24
GND
+3.3 V
RX14
RX15
CX1
C16
C14
R23
PA7
GND
C20
C21
C15
R22
GND
C24
9
C16
R21
+5 V
+5 V
C28 C2
5
R17 C1
PC0
PF1
PF3
PA1
PA2
PA6
C22
C23
JP7
U8
PC2
PC3
PC1
PF0
PF2
S1
RESET
JP9
PG0
PC6
PC4
PA0
STAT
JP8
PG2
PG3
PG1
PC7
C27
PD2
PD4
PC5
PA4
JP10
PD6
R18
C36
C35
CORE MODULE
GND/EGND
LINK
ACT
PD7
PD3
PD5
LCD1JC
RxF 485+ GND 485
Figure B-10. Install Four-Channel Push-Pull Driver Chips
96
RabbitCore RCM3309/RCM3319
Figure B-11 shows the stepper-motor driver circuit.
U2
PF4
27 kW
27 kW
27 kW
PF5
OUT1
MDA1
2
7
6
OUT2
MDA2
3
IN3
ENABLE2
10
11
OUT3
MDA3
4
IN4
15
14
OUT4
MDA4
5
VMA-
6
VMB-
1
2
1
IN2
9
27 kW
27 kW
27 kW
PF7
MOTOR +
{
MOTOR
{
MOTOR +
{
MOTOR
J4
3
OUT1
MDB1
2
7
6
OUT2
MDB2
3
IN3
ENABLE2
10
11
OUT3
MDB3
4
IN4
15
14
OUT4
MDB4
5
VMB+
6
IN1
2
ENABLE1
1
IN2
27 kW
PF6
{
L293DN
U3
®
1
3
IN1
ENABLE1
27 kW
®
J3
VMA+
9
L293DN
Figure B-11. Stepper-Motor Driver Circuit
The stepper motor(s) can be powered either from the onboard power supply or from an
external power based on the jumper settings on headers JP1 and JP2.
Table B-3. Stepper Motor Power-Supply Options
Header
Pins Connected
1–2
Onboard power supply to U2
9–10
Factory
Default
×
JP1
3–4
7–8
External power supply to U2
1–2
Onboard power supply to U3
9–10
×
JP2
3–4
7–8
User’s Manual
External power supply to U3
97
B.5 Prototyping Board Jumper Configurations
Figure B-12 shows the header locations used to configure the various Prototyping Board
options via jumpers.
JP1
JP2
JP3
JP4
Battery
JP5
Figure B-12. Location of Prototyping Board Configurable Positions
98
RabbitCore RCM3309/RCM3319
Table B-4 lists the configuration options using jumpers.
Table B-4. Prototyping Board Jumper Configurations
Header
JP1
JP2
JP3
JP4
JP5
Description
Stepper Motor Power-Supply
Options (U2)
Stepper Motor Power-Supply
Options (U3)
Pins Connected
1–2
Onboard power supply
9–10
3–4
7–8
RS-485 Bias and Termination
Resistors
User’s Manual
×
External power supply
1–2
Onboard power supply
9–10
×
3–4
7–8
External power supply
1–2
Quadrature decoder inputs enabled
2–3
RabbitNet/Serial Flash interface
enabled
×
2–3
RCM3309/RCM3319 powered via
Prototyping Board
×
1–2
5–6
Bias and termination resistors
connected
×
1–3
4–6
Bias and termination resistors not
connected (parking position for
jumpers)
PF0 Option
RCM3309/RCM3319 Power
Supply
Factory
Default
99
B.6 Use of Rabbit 3000 Parallel Ports
Table B-5 lists the Rabbit 3000 parallel ports and their use for the Prototyping Board.
Table B-5. Prototyping Board Use of Rabbit 3000 Parallel Ports
Port
I/O
Use
Initial State
PA0–PA3
Data Bus
LCD/keypad module, motor driver, LEDs, J7
Active high
PA4
Data Bus
LCD/keypad module, motor driver, relay, J7
Active high
PA5–PA7
Data Bus
LCD/keypad module, motor control, J7
Active high
PB0
Input
CLKB, RCM3309/RCM3319 serial flash
High
PB1
Input
CLKA, Programming Port
PB2–PB5
Address Bus
LCD/keypad module, J6
High
PB6–PB7
Address Bus
J6
High
PC0
Output
TXD SPI, , SF1000
serial flash, J7
PC1
Input
RXD SPI, , SF1000
serial flash, J7
PC2
Output
High
(when not driven by CLKA)
High (disabled)
Serial Port D
High (disabled)
TXC RS-485 J7
High (disabled)
Serial Port C
PC3
Input
PC4
Output
RXC RS-485 J7
High (disabled)
TXB RCM3309/RCM3319
serial flash
PC5
Input
RXB RCM3309/RCM3319
serial flash
PC6
Output
TXA, Programming Port
High (disabled)
Serial Port B*
High (disabled)
High
Serial Port A
RXA, Programming Port
High
Output
RCM3309 BSY LED
High
PD1†
Output
RCM3309 onboard serial flash select
PD2
Output
SPI, SF1000 serial flash, J7
Low (SPI disabled)
PD3
Output
SPI, SF1000 serial flash, J7
High (SPI CS disabled)
PD4–PD6
Input
PD7
Output
PE0–PE1
Input
PE2†
Output
Ethernet AEN
Low (disabled)
PE3
Output
Motor driver A clock pulse
Low (disabled)
PE4–PE5
Input
100
PC7
Input
PD0†
High (disabled)
SF1000 serial flash, J7
High (disabled)
RS-485 Tx enable
Low (disabled)
IN0–IN1, J6
IN2–IN3, J6
High
High
RabbitCore RCM3309/RCM3319
Table B-5. Prototyping Board Use of Rabbit 3000 Parallel Ports (continued)
Port
I/O
Use
Initial State
PE6
Output
LCD/keypad module
High (disabled)
PE7
Output
Motor driver B clock pulse
High (disabled)
PF0
Input
SPI, serial flash, quadrature decoder, J7
High
PF1–PF3
Input
Quadrature decoder, J7
High
PF4–PF7
Output
PG0
Input
Switch S1
High
PG1
Input
Switch S2
High
PG2
Input
TXF RS-232
Motor 1–4 control
Low (disabled)
High (disabled)
Serial Port F
PG3
Input
RXF RS-232
High (disabled)
PG4
Output
Motor driver A enable
High (disabled)
PG5
Output
Motor driver B enable
High (disabled)
PG6
Input
TXE RS-232
High (disabled)
Serial Port E
PG7
Input
RXE RS-232
High (disabled)
* Serial Port B is not available on the Prototyping Board when the RCM3309/RCM3319 is
plugged in.
† PD0, PD1, and PE2 are not normally available on the Prototyping Board because they are not
brought out on RCM3309 headers J3 and J4.
User’s Manual
101
102
RabbitCore RCM3309/RCM3319
APPENDIX C. LCD/KEYPAD MODULE
An optional LCD/keypad is available for the Prototyping Board.
Appendix C describes the LCD/keypad and provides the software function calls to make full use of the LCD/keypad.
C.1 Specifications
Two optional LCD/keypad modules—with or without a panel-mounted NEMA 4 waterresistant bezel—are available for use with the Prototyping Board. They are shown in
Figure C-1.
LCD/Keypad Modules
Figure C-1. LCD/Keypad Modules Versions
Only the version without the bezel can mount directly on the Prototyping Board; if you
have the version with a bezel, you will have to remove the bezel to be able to mount the
LCD/keypad module on the Prototyping Board. Either version of the LCD/keypad module
can be installed at a remote location up to 60 cm (24") away. Contact your Rabbit sales
representative or your authorized distributor for further assistance in purchasing an LCD/
keypad module.
User’s Manual
103
Mounting hardware and a 60 cm (24") extension cable are also available for the LCD/
keypad module through your sales representative or authorized distributor.
Table C-1 lists the electrical, mechanical, and environmental specifications for the LCD/
keypad module.
Table C-1. LCD/Keypad Specifications
Parameter
Specification
Board Size
2.60" × 3.00" × 0.75"
(66 mm × 76 mm × 19 mm)
Bezel Size
4.50" × 3.60" × 0.30"
(114 mm × 91 mm × 7.6 mm)
Temperature
Operating Range: 0°C to +50°C
Storage Range: –40°C to +85°C
Humidity
5% to 95%, noncondensing
Power Consumption
1.5 W maximum*
Connections
Connects to high-rise header sockets on the Prototyping Board
LCD Panel Size
122 × 32 graphic display
Keypad
7-key keypad
LEDs
Seven user-programmable LEDs
* The backlight adds approximately 650 mW to the power consumption.
The LCD/keypad module has 0.1"
IDC headers at J1, J2, and J3 for
physical connection to other boards or
ribbon cables. Figure C-2 shows the
LCD/keypad module footprint. These
values are relative to one of the
mounting holes.
(2.5)
(19.5)
0.768
(15.4)
0.607
J1
(40.6)
0.200
(5.1)
J3
J2
1.600
NOTE: All measurements are in
inches followed by millimeters
enclosed in parentheses. All dimensions have a manufacturing tolerance of ±0.01" (0.25 mm).
0.100
0.500
(12.7)
1.450
(36.8)
2.200
(55.9)
Figure C-2. User Board Footprint for
LCD/Keypad Module
104
RabbitCore RCM3309/RCM3319
C.2 Contrast Adjustments for All Boards
Starting in 2005, LCD/keypad modules were factory-configured to optimize their contrast
based on the voltage of the system they would be used in. Be sure to select a KDU3V LCD/
keypad module for use with the Prototyping Board for the RCM3309/RCM3319 — these
modules operate at 3.3 V. You may adjust the contrast using the potentiometer at R2 as
shown in Figure C-3. LCD/keypad modules configured for 5 V may be used with the 3.3 V
Prototyping Board, but the backlight will be dim.
LCD/Keypad Module Jumper Configurations
Description
Pins
Connected
Factory
Default
2.8 V
12
×
3.3 V
34
5V
n.c.
U3
D1
C7
JP1
R3
U2
C4
U1
R4
R5
C11
C13
U4
J5
CR1
C12
R7
LCD1
R6
D2 C1
C6
C9
C10
R2
C5
C2
Contrast
Adjustment
C3
J5
R1
Header
Q1
J5
Part No. 101-0541
R8
R26
R14
2
R20
1
4
R17
3
R10
Q4
Q6
OTHER LP3500
3.3 V 2.8 V
n.c. = 5 V
R12
R9
Q7
Q2
U6
U5
Q5
R15
R18
R13
R16
R11
J5
R21
2
Q3
R19
4
R23
1
R22
3
J1
R25
Q8
J2
U7 C14
C16 R24
C15
KP1
C17
RN1
DISPLAY
BOARD
J4
Figure C-3. LCD/Keypad Module Contrast Adjustments
You can set the contrast on the LCD display of pre-2005 LCD/keypad modules by adjusting the potentiometer at R2 or by setting the voltage for 3.3 V by connecting the jumper
across pins 3–4 on header J5 as shown in Figure C-3. Only one of these two options is
available on these LCD/keypad modules.
NOTE: Older LCD/keypad modules that do not have a header at J5 or a contrast adjustment potentiometer at R2 are limited to operate only at 5 V, and will not work with the
Prototyping Board for the RCM3309/RCM3319. The older LCD/keypad modules are
no longer being sold.
User’s Manual
105
C.3 Keypad Labeling
The keypad may be labeled according to your needs. A template is provided in Figure C-4
to allow you to design your own keypad label insert.
1.10
(28)
2.35
(60)
Figure C-4. Keypad Template
To replace the keypad legend, remove the old legend and insert your new legend prepared
according to the template in Figure C-4. The keypad legend is located under the blue keypad matte, and is accessible from the left only as shown in Figure C-5.
Keypad label is located
under the blue keypad matte.
Figure C-5. Removing and Inserting Keypad Label
The sample program KEYBASIC.C in the 122x32_1x7 folder in SAMPLES\LCD_KEYPAD
shows how to reconfigure the keypad for different applications.
106
RabbitCore RCM3309/RCM3319
C.4 Header Pinouts
DB6B
DB4B
DB2B
DB0B
A1B
A3B
GND
LED7
LED5
LED3
LED1
/RES
VCC
Figure C-6 shows the pinouts for the LCD/keypad module.
J3
GND
LED7
LED5
LED3
LED1
/RES
VCC
GND
DB6B
DB4B
DB2B
DB0B
A1B
A3B
DB7B
DB5B
DB3B
DB1B
A0B
A2B
GND
GND
LED6
LED4
LED2
PE7
+5BKLT
J1
GND
GND
LED6
LED4
LED2
PE7
+5BKLT
GND
DB7B
DB5B
DB3B
DB1B
A0B
A2B
J2
Figure C-6. LCD/Keypad Module Pinouts
C.4.1 I/O Address Assignments
The LCD and keypad on the LCD/keypad module are addressed by the /CS strobe as
explained in Table C-2.
Table C-2. LCD/Keypad Module Address Assignment
Address
User’s Manual
Function
0xE000
Device select base address (/CS)
0xExx0–0xExx7
LCD control
0xExx8
LED enable
0xExx9
Not used
0xExxA
7-key keypad
0xExxB (bits 0–6)
7-LED driver
0xExxB (bit 7)
LCD backlight on/off
0xExxC–ExxF
Not used
107
C.5 Mounting LCD/Keypad Module on the Prototyping Board
+DC
GND
J1
J2
J3
C14
C15
1
R25 R26
R23
RELAY RATED
0.5 A @ 30 V
BD7
BD6
BD5
BD4
D6
K E Y PA D D I S P L AY B O A R D
R44
C27
C28
C30
Q5
LCD1JC
R46
U1
JP2 JP3 JP4 JP5
U2
R15
LCD1JB
LCD1JB
C29
R47
R48
R38
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
D5
D3
D1
D7
R43
R5
R6
C22
D8
R35
JP5
C26
R45
C11
C10
R4
J1
R2
C21
R36
D4
D2
D0
A3
GND
A1
A0
A2
GND
C20
C8
C9
U4
U3
C23
C24
BD3
BD2
BA3
BD1
BA2
BD0
LCD
/CS
BA0
BA1
LED6
LED4
Y1 C5
J2
JP1
HO1
LED2
L1
R32
GND
C18
C13
R11
HO2
LED0
C17
R33
R34
J3
C33
HO3
LED5
C26
C32
HO4
R41
L2
R16
R30
/RES
C31
R14
GND
+V
Y2
R13
R12
R31
LED3
6
R29
/CS
U7 R19
C34
C30
DS2 DS3 DS4 DS5 DS6
J14
LED1
R21
R20
C29
CORE
D7
+BKLT
DS1
S3
D6
K1
U12
R37
DS2
R33
S2
D5
U9
J17
R42
C18
DS3
R34
R49
S1
RESET
R18
D4
Q6
C17
Q1
J9
R50
J13
JB
C1
R27 R28
J12
C19
U11
U10
R1
Q4
R20
R24 Y3
DS4
Q3
LCD1JA
R40
DX2
R3
Q2
J16
LCD1JA
UX3
UX4
UX5
UX1
UX2
C6
R25 R26
Q1
DX1
C12
JA
C16
GND
STAT
C24 C20
C21
PA7
C2
PA5
PA6
C28 C25U
PA3
PA4
R21 R22 R23 R24
C4
PA2
C16
+3.3 V
R39 J15
C3
PA1
GND
+3.3 V
RX18
R8
PF3
PA0
RX16
RX17
C7
R7
PF1
PF2
U8
R10
PF0
RX14
R9
PC0
RX13
C25
JP14
C46
2
C38
PC1
GND
RX15
U5
PC2
+5 V
+5 V
C14
PC4
PC3
R17 C19 C15
PC6
PC5
JP7
PC7
JP9
PG0
JP8
PG1
C27 C22
C23
PG2
R19
SERIAL
FLASH/
MODEM
C37
C36
PD4
JP10
PD2
PD5
C35
PD6
PD3
GND/EGND
J11
R18
R27
C44 C39
C40 R22
C43 U8
R30
PD7
PG3
R10
R17
C10
C11
C12
JP4
C13
R15
C47
LINK
JP3
R3
R4
R5
R6
R11
C9
BT1
JP13
R32
C48
R31
R35
CE
BSY
SPD LNK FDX
ACT COL
CORE MODULE
ACT
RABBITNET
U7 C7
C5
D3
U5
R16
R28
PF4 PF6 PE7
U4
RCM3300
PROTOTYPING
BOARD
R8 U6 C6
C41
C42
/RES_OUT
C8
Q2
PB2
PB0
RX12
OUT
RP7
RP6
RCM39XX
PB3
RX11
R9
R14
A0 A1 A2 A3 A4 A5 A6 A7
D1
PB4
RX10
RP3
RP4
J10
R29 U10
PB6
PB5
C4
R13
U1
OUT
U9
PB7
R12
RP5
RX9
U3
L293D
H-DRIVER
C45
PF5
RX8
R2
JP1
PE6
RX7
RX5
RX6
JP2
PE5
RX4
JP11
PE3
U2
L293D
H-DRIVER
JP12
PE0
PE4
C3
RP2
R7
GND
DS1
+DC
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
C2
D2
C49
C50
PG6
PE1
PF7
RX3
L1
PG7
+5V QD2A QD2B QD1A QD1B GND J5
/IORD
+5V
SMODE1
PG5
RP1
RX2
SM0
PG4
RX1
C1
/RES
/IOWR
IN0
VRAM
IN1
+3.3 V
VBT
IN2
GND
GND IN3
D1
NC
J6
R1
J8
GND
J7
GND
Install the LCD/keypad module on header sockets LCD1JA, LCD1JB, and LCD1JC of the
Prototyping Board as shown in Figure C-7. Be careful to align the pins over the headers,
and do not bend them as you press down to mate the LCD/keypad module with the Prototyping Board.
LCD1JC
TxE RxE GND TxF RxF 485+ GND 485
Figure C-7. Install LCD/Keypad Module on Prototyping Board
108
RabbitCore RCM3309/RCM3319
C.6 Bezel-Mount Installation
This section describes and illustrates how to bezel-mount the LCD/keypad module
designed for remote installation. Follow these steps for bezel-mount installation.
1. Cut mounting holes in the mounting panel in accordance with the recommended dimensions in Figure C-8, then use the bezel faceplate to mount the LCD/keypad module onto
the panel.
0.125 D, 4x
0.230
(5.8)
2.870
(86.4)
0.130
(3.3)
CUTOUT
3.400
(3)
(72.9)
3.100
(78.8)
Figure C-8. Recommended Cutout Dimensions
2. Carefully “drop in” the LCD/keypad module with the bezel and gasket attached.
User’s Manual
109
3. Fasten the unit with the four 4-40 screws and washers included with the LCD/keypad
module. If your panel is thick, use a 4-40 screw that is approximately 3/16" (5 mm)
longer than the thickness of the panel.
Bezel/Gasket
DISPLAY BOARD
U1
C1
U2
C4
U3
C3
C2
Q1
R17
D1
J1
R1
R2
R4
R3
R5
R7
R6
R8
R15
R14
R13
R12
R11
R9
R10
Panel
R18
Q2
Q3
Q4
Q5
Q6
Q8
Q7
C5
R16
KP1
J3
RN1
U4
C6
C7
C8
J2
Figure C-9. LCD/Keypad Module Mounted in Panel (rear view)
Carefully tighten the screws until the gasket is compressed and the plastic bezel faceplate is touching the panel.
Do not tighten each screw fully before moving on to the next screw. Apply only one or
two turns to each screw in sequence until all are tightened manually as far as they can
be so that the gasket is compressed and the plastic bezel faceplate is touching the panel.
110
RabbitCore RCM3309/RCM3319
C.6.1 Connect the LCD/Keypad Module to Your Prototyping Board
The LCD/keypad module can be located as far as 2 ft. (60 cm) away from the Prototyping
Board, and is connected via a ribbon cable as shown in Figure C-10.
C5
D1
C7
JP1
R3
U2
C4
U1
C10
C9
R4
R5
C11
Pin 1
CR1
C13
C12
R7
LCD1
R6
D2 C1
C6
C3
R1
C2
R2
U3
U4
Q1
J5
J1
R25
R8
R26
Q6
OTHER LP3500
Q3
R19
Q4
R12
R9
R20
2
Q2
Q7
Q8
U5
U6
3.3 V 2.8 V
n.c. = 5 V
R15
Q5
R18
R10
R16
R14
R23
4
R17
1
R21
R13
R22
R11
J5
3
J2
U7 C14
C16 R24
C15
KP1
RN1
C17
DISPLAY
BOARD
J4
PA5
PA3
PA1
PF3
PF2
PF1
PF0
PC0
PC1
PC2
PC3
PC4
PC5
JA
Q2
Q1
JB
Q4
Q3
J13
PG0
PG2
PD4
PD5
PD2
PD3
PD6
PD7
LINK
ACT
R10
U5
R3
R9
C14
JP7
JP9
JP8
JP10
C27 C22
C23
J3
C35
RX17
RX14
RX13
RX16
U7 R19
PE0
PG6
PG5
PG4
/IOWR
VRAM
VBT
+3.3 V
GND
NC
GND
R30
R32
R35
C44 C39
C38
C43 U8
SPD LNK FDX
ACT COL
SMODE1
J11
BT1
A0 A1 A2 A3 A4 A5 A6 A7
U1
OUT
OUT
J10
R13
C4
L293D
H-DRIVER
L1
/RES
D3
RP7
U2
R14
L293D
H-DRIVER
C5
D2
R9
R8 U6 C6
U3
C2
C1
C3
RX3
RX2
RX1
D1
J8
J2
GND
+DC
J4 VMB MDB1 MDB2 MDB3 MDB4 VMB+ VMA+ MDA1 MDA2 MDA3 MDA4 VMA POWER
GND
RP2
RP1
RX6
RP4
RX9
U7 C7
RP3
RX7
RX4
RABBITNET
RX12
RX8
RX5
RX11
RX10
DS1
R1
JP3
/IORD
SERIAL
FLASH/
MODEM
R2
R7
SM0
R27
JP13
C48
R31
BSY
CE
PE3
PE1
PG7
R12
+5 V
JP11
C40 R22
PE5
RP6
R11
PE4
C47
U4
C8
C9
C10
C11
C12
PF4 PF6 PE7
JP4
PF7
U5
C13
R17
R3
R4
R5
R6
JP1
RP5
J16
C14
C15
R10
+5V QD2A QD2B QD1A QD1B GND J5
PB6
C49
C50
DS3
DS4
PB4
R15
JP12
DS2
PB2
Q2
RCM39XX
R34
PB7
+3.3 V
R18
D1
U9
DS1
R33
Q1
PB5
JP14
R28
R29 U10
PB3
C46
C45
R16
J17
GND
+5 V
R21
1
/RES_OUT
R42
GND
R20
R25 R26
2
PB0
C19
R39 J15
+3.3 V
C37
C36
RX18
RX15
C29
L1
C33
L2
C34
RCM3300
PROTOTYPING
BOARD
R47
LCD1JA
C24 C20
C21
C26
C32
R16
C31
PE6
UX3
UX4
C30
D8
R40
UX5
DX1
C29
U12
U11
K1
DX2
UX1
UX2
C28 C25U
C30
CORE MODULE
R14
Y2
GND/EGND
R13
PF5
R35
U10
C3
C4
R17 C19 C15
PC6
PC7
PG3
R36
U9
C12
U8
PG1
R8
C16
C7
R7
R21 R22 R23 R24
R38
LCD
/CS
BA0
BA1
BA2
BA3
BD0
BD1
BD2
BD3
BD5
BD6
BD7
R19
R20
+5V
PA7
Q5
K E Y PA D D I S P L AY B O A R D
+V
/RES
LED0
LED2
LED4
LED6
GND
A3
A1
D0
D4
BD4
D2
D6
R12
J3
IN0
PA0
JP5
C26
RELAY RATED
0.5 A @ 30 V
JP2
IN1
PA2
J12
C23
C24
+BKLT
/CS
LED1
LED3
GND
LED5
GND
A2
A0
D1
D3
D5
D7
C18
6
C41
C42
IN2
PA4
R50
R27 R28
C11
C13
R24 Y3
GND IN3
PA6
R25 R26
C10
R11
R23
J6
GND
LCD1JC
LCD1JB
J14
D7
C2
J9
D6
D5
D4
C1
Q6
R1
CORE
R49
R41
C20
C8
C9
U4
R18
J7
STAT
TxE RxE GND TxF RxF 485+ GND 485
DS2 DS3 DS4 DS5 DS6
S3
C22
C18
C17
R33
R34
C27
R43
C28
R44
C6
S2
J2
JP2 JP3 JP4 JP5
R5
R6
U3
Y1 C5
C16
S1
RESET
GND
HO4
JP1
R4
C17
LCD1JA
R29
HO3
HO2
HO1
C21
U2
J1
R30
C25
R37
R45
R46
Pin 1
R15
R2
R31
R32
R48
DS7
RELAY NO1 COM1 NC1 NO2 COM2 NC2
U1
J1
GND
+DC
Figure C-10. Connecting LCD/Keypad Module to Prototyping Board
Note the locations and connections relative to pin 1 on both the Prototyping Board and the
LCD/keypad module.
Rabbit offers 2 ft. (60 cm) extension cables. Contact your authorized distributor or a Rabbit sales representative for more information.
User’s Manual
111
C.7 Sample Programs
Sample programs illustrating the use of the LCD/keypad module with the Prototyping
Board are provided in the SAMPLES\RCM3300\LCD_KEYPAD folder.
These sample programs use the external I/O bus on the Rabbit 3000 chip, and so the
#define PORTA_AUX_IO line is already included in the sample programs.
Each sample program has comments that describe the purpose and function of the program. Follow the instructions at the beginning of the sample program. To run a sample
program, open it with the File menu (if it is not still open), then compile and run it by
pressing F9. The RCM3309/RCM3319 must be connected to a PC using the programming
cable as described in Chapter 2, “Getting Started.”
Complete information on Dynamic C is provided in the Dynamic C User’s Manual.
• KEYPADTOLED.C—This program demonstrates the use of the external I/O bus. The
program will light up an LED on the LCD/keypad module and will display a message
on the LCD when a key press is detected. The DS3, DS4, DS5, and DS6 LEDs on the
Prototyping Board and the red BSY LED (DS4) on the RCM3309/RCM3319 module
will also light up.
• LCDKEYFUN.C—This program demonstrates how to draw primitive features from the
graphic library (lines, circles, polygons), and also demonstrates the keypad with the key
release option.
• SWITCHTOLCD.C—This program demonstrates the use of the external I/O bus. The
program will light up an LED on the LCD/keypad module and will display a message on
the LCD when a switch press is detected. The DS1 and DS2 LEDs on the Prototyping
Board will also light up.
Additional sample programs are available in the SAMPLES\LCD_KEYPAD\122x32_1x7
folder.
112
RabbitCore RCM3309/RCM3319
C.8 LCD/Keypad Module Function Calls
When mounted on the Prototyping Board, the LCD/keypad module uses the external I/O
bus on the Rabbit 3000 chip. Remember to add the line
#define PORTA_AUX_IO
to the beginning of any programs using the auxiliary I/O bus.
C.8.1 LCD/Keypad Module Initialization
The function used to initialize the LCD/keypad module can be found in the Dynamic C
LIB\DISPLAYS\LCD122KEY7.LIB library.
dispInit
void dispInit();
DESCRIPTION
Initializes the LCD/keypad module. The keypad is set up using keypadDef() or
keyConfig() after this function call.
RETURN VALUE
None.
User’s Manual
113
C.8.2 LEDs
When power is applied to the LCD/keypad module for the first time, the red LED (DS1)
will come on, indicating that power is being applied to the LCD/keypad module. The red
LED is turned off when the brdInit function executes.
One function is available to control the LEDs, and can be found in the Dynamic C LIB\
library.
DISPLAYS\LCD122KEY7.LIB
displedOut
void displedOut(int led, int value);
DESCRIPTION
LED on/off control. This function will only work when the LCD/keypad module is installed on the Prototyping Board.
PARAMETERS
led
is the LED to control.
0 = LED DS1
1 = LED DS2
2 = LED DS3
3 = LED DS4
4 = LED DS5
5 = LED DS6
6 = LED DS7
value
is the value used to control whether the LED is on or off (0 or 1).
0 = off
1 = on
RETURN VALUE
None.
114
RabbitCore RCM3309/RCM3319
C.8.3 LCD Display
The functions used to control the LCD display are contained in the GRAPHIC.LIB library
located in the Dynamic C LIB\DISPLAYS\GRAPHIC library folder. When x and y coordinates on the display screen are specified, x can range from 0 to 121, and y can range from
0 to 31. These numbers represent pixels from the top left corner of the display.
glInit
void glInit(void);
DESCRIPTION
Initializes the display devices, clears the screen.
RETURN VALUE
None.
SEE ALSO
glDispOnOFF, glBacklight, glSetContrast, glPlotDot, glBlock, glPlotDot,
glPlotPolygon, glPlotCircle, glHScroll, glVScroll, glXFontInit, glPrintf,
glPutChar, glSetBrushType, glBuffLock, glBuffUnlock, glPlotLine
glBackLight
void glBackLight(int onOff);
DESCRIPTION
Turns the display backlight on or off.
PARAMETER
onOff
turns the backlight on or off
1—turn the backlight on
0—turn the backlight off
RETURN VALUE
None.
SEE ALSO
glInit, glDispOnoff, glSetContrast
User’s Manual
115
glDispOnOff
void glDispOnOff(int onOff);
DESCRIPTION
Sets the LCD screen on or off. Data will not be cleared from the screen.
PARAMETER
onOff
turns the LCD screen on or off
1—turn the LCD screen on
0—turn the LCD screen off
RETURN VALUE
None.
SEE ALSO
glInit, glSetContrast, glBackLight
glSetContrast
void glSetContrast(unsigned level);
DESCRIPTION
Sets display contrast.
NOTE: This function is not used with the LCD/keypad module since the support circuits
are not available on the LCD/keypad module.
116
RabbitCore RCM3309/RCM3319
glFillScreen
void glFillScreen(int pattern);
DESCRIPTION
Fills the LCD display screen with a pattern.
PARAMETER
The screen will be set to all black if pattern is 0xFF, all white if pattern is 0x00,
and vertical stripes for any other pattern.
RETURN VALUE
None.
SEE ALSO
glBlock, glBlankScreen, glPlotPolygon, glPlotCircle
glBlankScreen
void glBlankScreen(void);
DESCRIPTION
Blanks the LCD display screen (sets LCD display screen to white).
RETURN VALUE
None.
SEE ALSO
glFillScreen, glBlock, glPlotPolygon, glPlotCircle
User’s Manual
117
glFillRegion
void glFillRegion(int left, int top, int width, int height,
char pattern);
DESCRIPTION
Fills a rectangular block in the LCD buffer with the pattern specified. Any portion of
the block that is outside the LCD display area will be clipped..
PARAMETERS
left
the x coordinate of the top left corner of the block.
top
the y coordinate of the top left corner of the block.
width
the width of the block.
height
the height of the block.
pattern
the bit pattern to display (all black if pattern is 0xFF, all white
if pattern is 0x00, and vertical stripes for any other pattern).
RETURN VALUE
None.
SEE ALSO
glFillScreen, glBlankScreen, glBlock, glBlankRegion
118
RabbitCore RCM3309/RCM3319
glFastFillRegion
void glFastFillRegion(int left, int top, int width, int height,
char pattern);
DESCRIPTION
Fills a rectangular block in the LCD buffer with the pattern specified. The block left and
width parameters must be byte-aligned. Any portion of the block that is outside the
LCD display area will be clipped..
PARAMETERS
left
the x coordinate of the top left corner of the block.
top
the y coordinate of the top left corner of the block.
width
the width of the block.
height
the height of the block.
pattern
the bit pattern to display (all black if pattern is 0xFF, all white
if pattern is 0x00, and vertical stripes for any other pattern).
RETURN VALUE
None.
SEE ALSO
glFillScreen, glBlankScreen, glBlock, glBlankRegion
User’s Manual
119
glBlankRegion
void glBlankRegion(int left, int top, int width, int height);
DESCRIPTION
Clears a region on the LCD display. The block left and width parameters must be bytealigned. Any portion of the block that is outside the LCD display area will be clipped..
PARAMETERS
left
the x coordinate of the top left corner of the block (x must be
evenly divisible by 8).
top
the y coordinate of the top left corner of the block.
width
the width of the block (must be evenly divisible by 8).
height
the height of the block.
RETURN VALUE
None.
SEE ALSO
glFillScreen, glBlankScreen, glBlock
120
RabbitCore RCM3309/RCM3319
glBlock
void glBlock(int left, int top, int width, int height);
DESCRIPTION
Draws a rectangular block in the page buffer and on the LCD if the buffer is unlocked.
Any portion of the block that is outside the LCD display area will be clipped.
PARAMETERS
left
the x coordinate of the top left corner of the block.
top
the y coordinate of the top left corner of the block.
width
the width of the block.
height
the height of the block.
RETURN VALUE
None.
SEE ALSO
glFillScreen, glBlankScreen, glPlotPolygon, glPlotCircle
glPlotVPolygon
void glPlotVPolygon(int n, int *pFirstCoord);
DESCRIPTION
Plots the outline of a polygon in the LCD page buffer, and on the LCD if the buffer is unlocked. Any portion of the polygon that is outside the LCD display area will be clipped.
If fewer than 3 vertices are specified, the function will return without doing anything.
PARAMETERS
n
the number of vertices.
pFirstCoord
a pointer to array of vertex coordinates: x1,y1, x2,y2,
x3,y3, ...
RETURN VALUE
None.
SEE ALSO
glPlotPolygon, glFillPolygon, glFillVPolygon
User’s Manual
121
glPlotPolygon
void glPlotPolygon(int n, int y1, int x2, int y2, ...);
DESCRIPTION
Plots the outline of a polygon in the LCD page buffer and on the LCD if the buffer is
unlocked. Any portion of the polygon that is outside the LCD display area will be
clipped. If fewer than 3 vertices are specified, the function will return without doing
anything.
PARAMETERS
n
the number of vertices.
y1
the y coordinate of the first vertex.
x1
the x coordinate of the first vertex.
y2
the y coordinate of the second vertex.
x2
the x coordinate of the second vertex.
...
the coordinates of additional vertices.
RETURN VALUE
None.
SEE ALSO
glPlotVPolygon, glFillPolygon, glFillVPolygon
122
RabbitCore RCM3309/RCM3319
glFillVPolygon
void glFillVPolygon(int n, int *pFirstCoord);
DESCRIPTION
Fills a polygon in the LCD page buffer and on the LCD screen if the buffer is unlocked.
Any portion of the polygon that is outside the LCD display area will be clipped. If fewer
than 3 vertices are specified, the function will return without doing anything.
PARAMETERS
n
the number of vertices.
pFirstCoord
a pointer to array of vertex coordinates: x1,y1, x2,y2,
x3,y3, ...
RETURN VALUE
None.
SEE ALSO
glFillPolygon, glPlotPolygon, glPlotVPolygon
User’s Manual
123
glFillPolygon
void glFillPolygon(int n, int x1, int y1, int x2, int y2, ...);
DESCRIPTION
Fills a polygon in the LCD page buffer and on the LCD if the buffer is unlocked. Any
portion of the polygon that is outside the LCD display area will be clipped. If fewer than
3 vertices are specified, the function will return without doing anything.
PARAMETERS
n
the number of vertices.
x1
the x coordinate of the first vertex.
y1
the y coordinate of the first vertex.
x2
the x coordinate of the second vertex.
y2
the y coordinate of the second vertex.
...
the coordinates of additional vertices.
RETURN VALUE
None.
SEE ALSO
glFillVPolygon, glPlotPolygon, glPlotVPolygon
124
RabbitCore RCM3309/RCM3319
glPlotCircle
void glPlotCircle(int xc, int yc, int rad);
DESCRIPTION
Draws the outline of a circle in the LCD page buffer and on the LCD if the buffer is
unlocked. Any portion of the circle that is outside the LCD display area will be clipped.
PARAMETERS
xc
the x coordinate of the center of the circle.
yc
the y coordinate of the center of the circle.
rad
the radius of the center of the circle (in pixels).
RETURN VALUE
None.
SEE ALSO
glFillCircle, glPlotPolygon, glFillPolygon
glFillCircle
void glFillCircle(int xc, int yc, int rad);
DESCRIPTION
Draws a filled circle in the LCD page buffer and on the LCD if the buffer is unlocked.
Any portion of the circle that is outside the LCD display area will be clipped.
PARAMETERS
xc
the x coordinate of the center of the circle.
yc
the y coordinate of the center of the circle.
rad
the radius of the center of the circle (in pixels).
RETURN VALUE
None.
SEE ALSO
glPlotCircle, glPlotPolygon, glFillPolygon
User’s Manual
125
glXFontInit
void glXFontInit(fontInfo *pInfo, char pixWidth, char pixHeight,
unsigned startChar, unsigned endChar, unsigned long xmemBuffer);
DESCRIPTION
Initializes the font descriptor structure, where the font is stored in xmem. Each font
character's bitmap is column major and byte aligned.
PARAMETERS
pInfo
a pointer to the font descriptor to be initialized.
pixWidth
the width (in pixels) of each font item.
pixHeight
the height (in pixels) of each font item.
startChar
the value of the first printable character in the font character set.
endChar
the value of the last printable character in the font character set.
xmemBuffer
the xmem pointer to a linear array of font bitmaps.
RETURN VALUE
None.
SEE ALSO
glPrinf
126
RabbitCore RCM3309/RCM3319
glFontCharAddr
unsigned long glFontCharAddr(fontInfo *pInfo, char letter);
DESCRIPTION
Returns the xmem address of the character from the specified font set.
PARAMETERS
pInfo
pointer to the xmem address of the bitmap font set.
letter
an ASCII character.
RETURN VALUE
xmem address of bitmap character font, column major and byte-aligned.
SEE ALSO
glPutFont, glPrintf
glPutFont
void glPutFont(int x, int y, fontInfo *pInfo, char code);
DESCRIPTION
Puts an entry from the font table to the page buffer and on the LCD if the buffer is unlocked. Each font character's bitmap is column major and byte-aligned. Any portion of
the bitmap character that is outside the LCD display area will be clipped.
PARAMETERS
x
the x coordinate (column) of the top left corner of the text.
y
the y coordinate (row) of the top left corner of the text.
pInfo
a pointer to the font descriptor.
code
the ASCII character to display.
RETURN VALUE
None.
SEE ALSO
glFontCharAddr, glPrintf
User’s Manual
127
glSetPfStep
void glSetPfStep(int stepX, int stepY);
DESCRIPTION
Sets the glPrintf() printing step direction. The x and y step directions are independent signed values. The actual step increments depend on the height and width of the
font being displayed, which are multiplied by the step values.
PARAMETERS
stepX
the glPrintf x step value
stepY
the glPrintf y step value
RETURN VALUE
None.
SEE ALSO
Use glGetPfStep() to examine the current x and y printing step direction.
glGetPfStep
int glGetPfStep(void);
DESCRIPTION
Gets the current glPrintf() printing step direction. Each step direction is independent of the other, and is treated as an 8-bit signed value. The actual step increments depends on the height and width of the font being displayed, which are multiplied by the
step values.
RETURN VALUE
The x step is returned in the MSB, and the y step is returned in the LSB of the integer
result.
SEE ALSO
Use glGetPfStep() to control the x and y printing step direction.
128
RabbitCore RCM3309/RCM3319
glPutChar
void glPutChar(char ch, char *ptr, int *cnt, glPutCharInst
*pInst)
DESCRIPTION
Provides an interface between the STDIO string-handling functions and the graphic library. The STDIO string-formatting function will call this function, one character at a
time, until the entire formatted string has been parsed. Any portion of the bitmap character that is outside the LCD display area will be clipped.
PARAMETERS
ch
the character to be displayed on the LCD.
ptr
not used, but is a place holder for a pointer to STDIO string
functions.
cnt
not used, is a place holder for for a pointer to STDIO string
functions.
pInst
a pointer to the font descriptor.
RETURN VALUE
None.
SEE ALSO
glPrintf, glPutFont, doprnt
User’s Manual
129
glPrintf
void glPrintf(int x, int y, fontInfo *pInfo, char *fmt, ...);
DESCRIPTION
Prints a formatted string (much like printf) on the LCD screen. Only the character
codes that exist in the font set are printed, all others are skipped. For example, '\b', '\t',
'\n' and '\r' (ASCII backspace, tab, new line, and carriage return, respectively) will be
printed if they exist in the font set, but will not have any effect as control characters.
Any portion of the bitmap character that is outside the LCD display area will be clipped.
PARAMETERS
x
the x coordinate (column) of the upper left corner of the text.
y
the y coordinate (row) of the upper left corner of the text.
pInfo
a pointer to the font descriptor.
fmt
pointer to a formatted string.
...
formatted string conversion parameter(s).
EXAMPLE
glprintf(0,0, &fi12x16, "Test %d\n", count);
RETURN VALUE
None.
SEE ALSO
glXFontInit
130
RabbitCore RCM3309/RCM3319
glBuffLock
void glBuffLock(void);
DESCRIPTION
Increments LCD screen locking counter. Graphic calls are recorded in the LCD memory buffer and are not transferred to the LCD if the counter is non-zero.
NOTE: glBuffLock() and glBuffUnlock() can be nested up to a level of 255, but be
sure to balance the calls. It is not a requirement to use these procedures, but a set of
glBuffLock() and glBuffUnlock() bracketing a set of related graphic calls speeds
up the rendering significantly.
RETURN VALUE
None.
SEE ALSO
glBuffUnlock, glSwap
glBuffUnlock
void glBuffUnlock(void);
DESCRIPTION
Decrements the LCD screen locking counter. The contents of the LCD buffer are transferred to the LCD if the counter goes to zero.
RETURN VALUE
None.
SEE ALSO
glBuffLock, glSwap
User’s Manual
131
glSwap
void glSwap(void);
DESCRIPTION
Checks the LCD screen locking counter. The contents of the LCD buffer are transferred
to the LCD if the counter is zero.
RETURN VALUE
None.
SEE ALSO
glBuffUnlock, glBuffLock, _glSwapData (located in the library specifically for
the LCD that you are using)
glSetBrushType
void glSetBrushType(int type);
DESCRIPTION
Sets the drawing method (or color) of pixels drawn by subsequent graphic calls.
PARAMETER
type
value can be one of the following macros.
PIXBLACK draws black pixels (turns pixel on).
PIXWHITE draws white pixels (turns pixel off).
PIXXOR draws old pixel XOR'ed with the new pixel.
RETURN VALUE
None.
SEE ALSO
glGetBrushType
132
RabbitCore RCM3309/RCM3319
glGetBrushType
int glGetBrushType(void);
DESCRIPTION
Gets the current method (or color) of pixels drawn by subsequent graphic calls.
RETURN VALUE
The current brush type.
SEE ALSO
glSetBrushType
glXGetBitmap
void glXGetBitmap(int x, int y, int bmWidth, int bmHeight,
unsigned long xBm);
DESCRIPTION
Gets a bitmap from the LCD page buffer and stores it in xmem RAM. This function
automatically calls glXGetFastmap if the left edge of the bitmap is byte-aligned and
the left edge and width are each evenly divisible by 8.
This function call is intended for use only when a graphic engine is used to interface with
the LCD/keypad module.
PARAMETERS
x
the x coordinate in pixels of the top left corner of the bitmap (x
must be evenly divisible by 8).
y
the y coordinate in pixels of the top left corner of the bitmap.
bmWidth
the width in pixels of the bitmap (must be evenly divisible by 8).
bmHeight
the height in pixels of the bitmap.
xBm
the xmem RAM storage address of the bitmap.
RETURN VALUE
None.
User’s Manual
133
glXGetFastmap
void glXGetFastmap(int left, int top, int width, int height,
unsigned long xmemptr);
DESCRIPTION
Draws bitmap in the specified space. The data for the bitmap are stored in xmem. This
function is similar to glXPutBitmap(), except that it's faster. The bitmap must be
byte-aligned. Any portion of a bitmap image or character that is outside the LCD display
area will be clipped.
This function call is intended for use only when a graphic engine is used to interface with
the LCD/keypad module.
PARAMETERS
left
the x coordinate of the top left corner of the bitmap (x must be
evenly divisible by 8).
top
the y coordinate in pixels of the top left corner of the bitmap.
width
the width of the bitmap (must be evenly divisible by 8).
height
the height of the bitmap.
xmemptr
the xmem RAM storage address of the bitmap.
RETURN VALUE
None.
SEE ALSO
glXPutBitmap, glPrintf
134
RabbitCore RCM3309/RCM3319
glPlotDot
void glPlotDot(int x, int y);
DESCRIPTION
Draws a single pixel in the LCD buffer, and on the LCD if the buffer is unlocked. If the
coordinates are outside the LCD display area, the dot will not be plotted.
PARAMETERS
x
the x coordinate of the dot.
y
the y coordinate of the dot.
RETURN VALUE
None.
SEE ALSO
glPlotline, glPlotPolygon, glPlotCircle
glPlotLine
void glPlotLine(int x0, int y0, int x1, int y1);
DESCRIPTION
Draws a line in the LCD buffer, and on the LCD if the buffer is unlocked. Any portion
of the line that is beyond the LCD display area will be clipped.
PARAMETERS
x0
the x coordinate of one endpoint of the line.
y0
the y coordinate of one endpoint of the line.
x1
the x coordinate of the other endpoint of the line.
y1
the y coordinate of the other endpoint of the line.
RETURN VALUE
None.
SEE ALSO
glPlotDot, glPlotPolygon, glPlotCircle
User’s Manual
135
glLeft1
void glLeft1(int left, int top, int cols, int rows);
DESCRIPTION
Scrolls byte-aligned window left one pixel, right column is filled by current pixel type
(color).
PARAMETERS
left
the top left corner of bitmap, must be evenly divisible by 8, otherwise truncates.
top
the top left corner of the bitmap.
cols
the number of columns in the window, must be evenly divisible by 8,
otherwise truncates.
rows
the number of rows in the window.
RETURN VALUE
None.
SEE ALSO
glHScroll, glRight1
136
RabbitCore RCM3309/RCM3319
glRight1
void glRight1(int left, int top, int cols, int rows);
DESCRIPTION
Scrolls byte-aligned window right one pixel, left column is filled by current pixel type
(color).
PARAMETERS
left
the top left corner of bitmap, must be evenly divisible by 8, otherwise truncates.
top
the top left corner of the bitmap.
cols
the number of columns in the window, must be evenly divisible by 8,
otherwise truncates.
rows
the number of rows in the window.
RETURN VALUE
None.
SEE ALSO
glHScroll, glLeft1
User’s Manual
137
glUp1
void glUp1(int left, int top, int cols, int rows);
DESCRIPTION
Scrolls byte-aligned window up one pixel, bottom column is filled by current pixel type
(color).
PARAMETERS
left
the top left corner of bitmap, must be evenly divisible by 8, otherwise truncates.
top
the top left corner of the bitmap.
cols
the number of columns in the window, must be evenly divisible by 8,
otherwise truncates.
rows
the number of rows in the window.
RETURN VALUE
None.
SEE ALSO
glVScroll, glDown1
138
RabbitCore RCM3309/RCM3319
glDown1
void glDown1(int left, int top, int cols, int rows);
DESCRIPTION
Scrolls byte-aligned window down one pixel, top column is filled by current pixel type
(color).
PARAMETERS
left
the top left corner of bitmap, must be evenly divisible by 8, otherwise truncates.
top
the top left corner of the bitmap.
cols
the number of columns in the window, must be evenly divisible by 8,
otherwise truncates.
rows
the number of rows in the window.
RETURN VALUE
None.
SEE ALSO
glVScroll, glUp1
User’s Manual
139
glHScroll
void glHScroll(int left, int top, int cols, int rows, int nPix);
DESCRIPTION
Scrolls right or left, within the defined window by x number of pixels. The opposite
edge of the scrolled window will be filled in with white pixels. The window must be
byte-aligned.
Parameters will be verified for the following:
1. The left and cols parameters will be verified that they are evenly divisible by 8. If not,
they will be truncated to a value that is a multiple of 8.
2. Parameters will be checked to verify that the scrolling area is valid. The minimum scrolling area is a width of 8 pixels and a height of one row.
PARAMETERS
left
the top left corner of bitmap, must be evenly divisible by 8.
top
the top left corner of the bitmap.
cols
the number of columns in the window, must be evenly divisible by 8.
rows
the number of rows in the window.
nPix
the number of pixels to scroll within the defined window (a negative
value will produce a scroll to the left).
RETURN VALUE
None.
SEE ALSO
glVScroll
140
RabbitCore RCM3309/RCM3319
glVScroll
void glVScroll(int left, int top, int cols, int rows, int nPix);
DESCRIPTION
Scrolls up or down, within the defined window by x number of pixels. The opposite
edge of the scrolled window will be filled in with white pixels. The window must be
byte-aligned.
Parameters will be verified for the following:
1. The left and cols parameters will be verified that they are evenly divisible by 8. If not,
they will be truncated to a value that is a multiple of 8.
2. Parameters will be checked to verify that the scrolling area is valid. The minimum scrolling area is a width of 8 pixels and a height of one row.
PARAMETERS
left
the top left corner of bitmap, must be evenly divisible by 8.
top
the top left corner of the bitmap.
cols
the number of columns in the window, must be evenly divisible by 8.
rows
the number of rows in the window.
nPix
the number of pixels to scroll within the defined window (a negative
value will produce a scroll up).
RETURN VALUE
None.
SEE ALSO
glHScroll
User’s Manual
141
glXPutBitmap
void glXPutBitmap(int left, int top, int width, int height,
unsigned long bitmap);
DESCRIPTION
Draws bitmap in the specified space. The data for the bitmap are stored in xmem. This
function calls glXPutFastmap() automatically if the bitmap is byte-aligned (the
left edge and the width are each evenly divisible by 8).
Any portion of a bitmap image or character that is outside the LCD display area will be
clipped.
PARAMETERS
left
the top left corner of the bitmap.
top
the top left corner of the bitmap.
width
the width of the bitmap.
height
the height of the bitmap.
bitmap
the address of the bitmap in xmem.
RETURN VALUE
None.
SEE ALSO
glXPutFastmap, glPrintf
142
RabbitCore RCM3309/RCM3319
glXPutFastmap
void glXPutFastmap(int left, int top, int width, int height,
unsigned long bitmap);
DESCRIPTION
Draws bitmap in the specified space. The data for the bitmap are stored in xmem. This
function is like glXPutBitmap(), except that it is faster. The restriction is that the
bitmap must be byte-aligned.
Any portion of a bitmap image or character that is outside the LCD display area will be
clipped.
PARAMETERS
left
the top left corner of the bitmap, must be evenly divisible by 8,
otherwise truncates.
top
the top left corner of the bitmap.
width
the width of the bitmap, must be evenly divisible by 8, otherwise
truncates.
height
the height of the bitmap.
bitmap
the address of the bitmap in xmem.
RETURN VALUE
None.
SEE ALSO
glXPutBitmap, glPrintf
User’s Manual
143
TextWindowFrame
int TextWindowFrame(windowFrame *window, fontInfo *pFont, int x,
int y, int winWidth, int winHeight);
DESCRIPTION
Defines a text-only display window. This function provides a way to display characters
within the text window using only character row and column coordinates. The text window feature provides end-of-line wrapping and clipping after the character in the last
column and row is displayed.
NOTE: Execute the TextWindowFrame() function before other Text... functions.
PARAMETERS
window
a pointer to the window frame descriptor.
pFont
a pointer to the font descriptor.
x
the x coordinate of the top left corner of the text window frame.
y
the y coordinate of the top left corner of the text window frame.
winWidth
the width of the text window frame.
winHeight
the height of the text window frame.
RETURN VALUE
0—window frame was successfully created.
-1—x coordinate + width has exceeded the display boundary.
-2—y coordinate + height has exceeded the display boundary.
-3—Invalid winHeight and/or winWidth parameter value.
144
RabbitCore RCM3309/RCM3319
TextBorderInit
void TextBorderInit(windowFrame *wPtr, int border, char *title);
DESCRIPTION
This function initializes the window frame structure with the border and title information.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETERS
wPtr
a pointer to the window frame descriptor.
border
the border style:
SINGLE_LINE—The function will draw a single-line border
around the text window.
DOUBLE_LINE—The function will draw a double-line border around the text window.
title
a pointer to the title information:
If a NULL string is detected, then no title is written to the text
menu.
If a string is detected, then it will be written center-aligned to
the top of the text menu box.
RETURN VALUE
None.
SEE ALSO
TextBorder, TextGotoXY, TextPutChar, TextWindowFrame, TextCursorLocation
User’s Manual
145
TextBorder
void TextBorder(windowFrame *wPtr);
DESCRIPTION
This function displays the border for a given window frame. This function will automatically adjust the text window parameters to accommodate the space taken by the
text border. This adjustment will only occur once after the TextBorderInit()
function executes.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETER
wPtr
a pointer to the window frame descriptor.
RETURN VALUE
None.
SEE ALSO
TextBorderInit, TextGotoXY, TextPutChar, TextWindowFrame,
TextCursorLocation
TextGotoXY
void TextGotoXY(windowFrame *window, int col, int row);
DESCRIPTION
Sets the cursor location to display the next character. The display location is based on
the height and width of the character to be displayed.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETERS
window
a pointer to a font descriptor.
col
a character column location.
row
a character row location.
RETURN VALUE
None.
SEE ALSO
TextPutChar, TextPrintf, TextWindowFrame
146
RabbitCore RCM3309/RCM3319
TextCursorLocation
void TextCursorLocation(windowFrame *window, int *col, int *row);
DESCRIPTION
Gets the current cursor location that was set by a graphic Text... function.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETERS
window
a pointer to a font descriptor.
col
a pointer to cursor column variable.
row
a pointer to cursor row variable.
RETURN VALUE
Lower word = Cursor Row location
Upper word = Cursor Column location
SEE ALSO
TextGotoXY, TextPrintf, TextWindowFrame, TextCursorLocation
User’s Manual
147
TextPutChar
void TextPutChar(struct windowFrame *window, char ch);
DESCRIPTION
Displays a character on the display where the cursor is currently pointing. Once a character is displayed, the cursor will be incremented to the next character position. If any
portion of a bitmap character is outside the LCD display area, the character will not be
displayed.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETERS
window
a pointer to a font descriptor.
ch
a character to be displayed on the LCD.
RETURN VALUE
None.
SEE ALSO
TextGotoXY, TextPrintf, TextWindowFrame, TextCursorLocation
148
RabbitCore RCM3309/RCM3319
TextPrintf
void TextPrintf(struct windowFrame *window, char *fmt, ...);
DESCRIPTION
Prints a formatted string (much like printf) on the LCD screen. Only printable characters in the font set are printed; escape sequences '\r' and '\n' are also recognized. All
other escape sequences will be skipped over; for example, '\b' and \'t' will will cause
nothing to be displayed.
The text window feature provides end-of-line wrapping and clipping after the character
in the last column and row is displayed. The cursor then remains at the end of the string.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETERS
window
a pointer to a font descriptor.
fmt
a pointer to a formatted string.
...
formatted string conversion parameter(s).
EXAMPLE
TextPrintf(&TextWindow, "Test %d\n", count);
RETURN VALUE
None.
SEE ALSO
TextGotoXY, TextPutChar, TextWindowFrame, TextCursorLocation
User’s Manual
149
TextMaxChars
int TextMaxChars(windowFrame *wPtr);
DESCRIPTION
This function returns the maximum number of characters that can be displayed within
the text window.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETER
wPtr
a pointer to the window frame descriptor.
RETURN VALUE
The maximum number of characters that can be displayed within the text window.
SEE ALSO
TextGotoXY, TextPrintf, TextWindowFrame, TextCursorLocation
TextWinClear
void TextWinClear(windowFrame *wPtr);
DESCRIPTION
This functions clears the entire area within the specified text window.
NOTE: Execute the TextWindowFrame() function before using this function.
PARAMETERS
wPtr
a pointer to the window frame descriptor.
RETURN VALUE
None.
SEE ALSO
TextGotoXY, TextPrintf, TextWindowFrame, TextCursorLocation
150
RabbitCore RCM3309/RCM3319
C.8.4 Keypad
The functions used to control the keypad are contained in the Dynamic C LIB\KEYPADS\
KEYPAD7.LIB library.
keyInit
void keyInit(void);
DESCRIPTION
Initializes keypad process.
RETURN VALUE
None.
SEE ALSO
brdInit
User’s Manual
151
keyConfig
void keyConfig(char cRaw, char cPress, char cRelease,
char cCntHold, char cSpdLo, char cCntLo, char cSpdHi);
DESCRIPTION
Assigns each key with keypress and release codes, and hold and repeat ticks for auto
repeat and debouncing.
PARAMETERS
a raw key code index.
cRaw
1 × 7 keypad matrix with raw key code index assignments (in brackets):
[0]
[1]
[4]
[2]
[5]
[3]
[6]
User Keypad Interface
cPress
a keypress code
An 8-bit value is returned when a key is pressed.
0 = Unused.
See keypadDef() for default press codes.
cRelease
a key release code.
An 8-bit value is returned when a key is pressed.
0 = Unused.
cCntHold
a hold tick, which is approximately one debounce period or 5 µs.
How long to hold before repeating.
0 = No Repeat.
cSpdLo
a low-speed repeat tick, which is approximately one debounce
period or 5 µs.
How many times to repeat.
0 = None.
cCntLo
a low-speed hold tick, which is approximately one debounce period
or 5 µs.
How long to hold before going to high-speed repeat.
0 = Slow Only.
cSpdHi
a high-speed repeat tick, which is approximately one debounce
period or 5 µs.
How many times to repeat after low speed repeat.
0 = None.
152
RabbitCore RCM3309/RCM3319
keyConfig (contined)
RETURN VALUE
None.
SEE ALSO
keyProcess, keyGet, keypadDef
User’s Manual
153
keyProcess
void keyProcess(void);
DESCRIPTION
Scans and processes keypad data for key assignment, debouncing, press and release,
and repeat.
NOTE: This function is also able to process an 8 × 8 matrix keypad.
RETURN VALUE
None.
SEE ALSO
keyConfig, keyGet, keypadDef
keyGet
char keyGet(void);
DESCRIPTION
Get next keypress.
RETURN VALUE
The next keypress, or 0 if none.
SEE ALSO
keyConfig, keyProcess, keypadDef
154
RabbitCore RCM3309/RCM3319
keyUnget
int keyUnget(char cKey);
DESCRIPTION
Pushes the value of cKey to the top of the input queue, which is 16 bytes deep.
PARAMETER
cKey
RETURN VALUE
None.
SEE ALSO
keyGet
User’s Manual
155
keypadDef
void keypadDef();
DESCRIPTION
Configures the physical layout of the keypad with the desired ASCII return key codes.
1 × 7 keypad physical mapping:
0
4
['L']
1
5
2
['U']
['–']
6
['D']
3
['R']
['+']
['E']
where
'L' represents Left Scroll
'U' represents Up Scroll
'D' represents Down Scroll
'R' represents Right Scroll
'–' represents Page Down
'+' represents Page Up
'E' represents the ENTER key
Example: Do the following for the above physical vs. ASCII return key codes.
keyConfig
keyConfig
keyConfig
keyConfig
keyConfig
keyConfig
keyConfig
(
(
(
(
(
(
(
3,'R',0,
6,'E',0,
2,'D',0,
4,'-',0,
1,'U',0,
5,'+',0,
0,'L',0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
0
0
0
0
0
0
);
);
);
);
);
);
);
Characters are returned upon keypress with no repeat.
RETURN VALUE
None.
SEE ALSO
keyConfig, keyGet, keyProcess
156
RabbitCore RCM3309/RCM3319
keyScan
void keyScan(char *pcKeys);
DESCRIPTION
Writes "1" to each row and reads the value. The position of a keypress is indicated by
a zero value in a bit position.
PARAMETER
pcKeys
a pointer to the address of the value read.
RETURN VALUE
None.
SEE ALSO
keyConfig, keyGet, keypadDef, keyProcess
User’s Manual
157
158
RabbitCore RCM3309/RCM3319
APPENDIX D. POWER SUPPLY
Appendix D provides information on the current requirements
of the RCM3309/RCM3319, and includes some background on
the reset generator.
D.1 Power Supplies
Power is supplied from the motherboard to which the RCM3309/RCM3319 is connected
via header J62. The RCM3309/RCM3319 requires a regulated 3.15 V to 3.45 V DC power
source. An RCM3309/RCM3319 with no loading at the outputs operating at 44.2 MHz
typically draws 350 mA.
D.1.1 Battery Backup
The RCM3309/RCM3319 does not have a battery, but there is provision for a customersupplied battery to back up the data SRAM and keep the internal Rabbit 3000 real-time
clock running.
Header J62, shown in Figure D-1, allows access to the external battery. This header makes
it possible to connect an external 3 V power supply. This allows the SRAM and the internal Rabbit 3000 real-time clock to retain data with the RCM3309/RCM3319 powered
down.
External
Battery
J62
VRAM 29
+3.3 VIN
31
30
VBAT_EXT
32
GND
Figure D-1. External Battery Connections
at Header J4
User’s Manual
159
A lithium battery with a nominal voltage of 3 V and a minimum capacity of 165 mA·h is
recommended. A lithium battery is strongly recommended because of its nearly constant
nominal voltage over most of its life.
The drain on the battery by the RCM3309/RCM3319 is typically 6 µA when no other power
is supplied. If a 165 mA·h battery is used, the battery can last about 3 years:
165 mA·h
------------------------ = 3.1 years.
6 µA
The RCM3309/RCM3319 does not drain the battery while it is powered up normally.
Cycle the main power off/on on the RCM3309/RCM3319 after you install a backup battery
for the first time, and whenever you replace the battery. This step will minimize the current
drawn by the real-time clock oscillator circuit from the backup battery should the
RCM3309/RCM3319 experience a loss of main power.
NOTE: Remember to cycle the main power off/on any time the RCM3309/RCM3319 is
removed from the Protoyping Board or motherboard since that is where the backup
battery would be located.
Rabbit’s Technical Note TN235, External 32.768 kHz Oscillator Circuits, provides additional information about the current draw by the the real-time clock oscillator circuit.
D.1.2 Battery-Backup Circuit
Figure D-2 shows the battery-backup circuit.
VOSC
VRAM
External Battery
VBAT-EXT
D61
R74
R75
R10
150 kW
100 W
47 kW
C8
100 nF
C9
10 nF
Figure D-2. RCM33309/RCM3319 Backup Battery Circuit
The battery-backup circuit serves three purposes:
• It reduces the battery voltage to the SRAM and to the real-time clock, thereby limiting
the current consumed by the real-time clock and lengthening the battery life.
• It ensures that current can flow only out of the battery to prevent charging the battery.
• A voltage, VOSC, is supplied to U1, which keeps the 32.768 kHz oscillator working
when the voltage begins to drop.
160
RabbitCore RCM3309/RCM3319
D.1.3 Reset Generator
The RCM3309/RCM3319 uses a reset generator to reset the Rabbit 3000 microprocessor
when the voltage drops below the voltage necessary for reliable operation. The reset occurs
between 2.85 V and 3.00 V, typically 2.93 V.
The RCM3309/RCM3319 has a reset pin, pin 28 on header J4. This pin provides access to
the reset input of the reset generator, whose output drives the reset input of the Rabbit
3000 and peripheral circuits. The /RESET output from the reset generator is available on
pin 1 of header J4 on the RCM3309/RCM3319, and can be used to reset user-defined circuits on the motherboard on which the RCM3309/RCM3319 module is mounted.
User’s Manual
161
162
RabbitCore RCM3309/RCM3319
APPENDIX 0. RABBITNET
E.1 General RabbitNet Description
RabbitNet is a high-speed synchronous protocol developed by Rabbit to connect peripheral cards to a master and to allow them to communicate with each other.
E.1.1 RabbitNet Connections
All RabbitNet connections are made point to point. A RabbitNet master port can only be
connected directly to a peripheral card, and the number of peripheral cards is limited by
the number of available RabbitNet ports on the master.
SLAVE
Straight-through
Ethernet cable
SLAVE
Rabbit 3000®
Microprocessor
MASTER
Crossover
Ethernet cable
MASTER
SLAVE
Straight-through
Ethernet cable
Figure 1. Connecting Peripheral Cards to a Master
User’s Manual
163
Use a straight-through Ethernet cable to connect the master to slave peripheral cards, unless
you are using a device such as the OP7200 that could be used either as a master or a slave. In
this case you would use a crossover cable to connect an OP7200 that is being used as a slave.
Distances between a master unit and peripheral cards can be up to 10 m or 33 ft.
E.1.2 RabbitNet Peripheral Cards
• Digital I/O
24 inputs, 16 push/pull outputs, 4 channels of 10-bit A/D conversion with ranges of
0 to 10 V, 0 to 1 V, and -0.25 to +0.25 V. The following connectors are used:
Signal = 0.1" friction-lock connectors
Power = 0.156" friction-lock connectors
RabbitNet = RJ-45 connector
• A/D converter
8 channels of programmable-gain 12-bit A/D conversion, configurable as current measurement and differential-input pairs. 2.5 V reference voltage is available on the connector. The following connectors are used:
Signal = 0.1" friction-lock connectors
Power = 0.156" friction-lock connectors
RabbitNet = RJ-45 connector
• D/A converter
8 channels of 0–10 V 12-bit D/A conversion. The following connectors are used:
Signal = 0.1" friction-lock connectors
Power = 0.156" friction-lock connectors
RabbitNet = RJ-45 connector
• Display/Keypad interface
allows you to connect your own keypad with up to 64 keys and one character liquid
crystal display from 1 × 8 to 4 × 40 characters with or without backlight using standard
1 × 16 or 2 × 8 connectors. The following connectors are used:
Signal = 0.1" headers or sockets
Power = 0.156" friction-lock connectors
RabbitNet = RJ-45 connector
• Relay card
6 relays rated at 250 V AC, 1200 V·A or 100 V DC up to 240 W. The following connectors are
used:
Relay contacts = screw-terminal connectors
Power = 0.156" friction-lock connectors
RabbitNet = RJ-45 connector
Visit our Web site for up-to-date information about additional cards and features as they
become available. The Web site also has the latest revision of this user’s manual.
164
RabbitCore RCM3309/RCM3319
E.2 Physical Implementation
There are four signaling functions associated with a RabbitNet connection. From the master’s point of view, the transmit function carries information and commands to the peripheral card. The receive function is used to read back information sent to the master by the
peripheral card. A clock is used to synchronize data going between the two devices at high
speed. The master is the source of this clock. A slave select (SS) function originates at the
master, and when detected by a peripheral card causes it to become selected and respond
to commands received from the master.
The signals themselves are differential RS-422, which are series-terminated at the source.
With this type of termination, the maximum frequency is limited by the round-trip delay
time of the cable. Although a peripheral card could theoretically be up to 45 m (150 ft)
from the master for a data rate of 1 MHz, Rabbit recommends a practical limit of 10 m (33
ft).
Connections between peripheral cards and masters are done using standard 8-conductor
Ethernet cables. Masters and peripheral cards are equipped with RJ-45 8-pin female connectors. The cables may be swapped end for end without affecting functionality.
E.2.1 Control and Routing
Control starts at the master when the master asserts the slave select signal (SS). Then it
simultaneously sends a serial command and clock. The first byte of a command contains
the address of the peripheral card if more than one peripheral card is connected.
A peripheral card assumes it is selected as soon as it receives the select signal. For direct
master-to-peripheral-card connections, this is as soon as the master asserts the select signal. The connection is established once the select signal reaches the addressed slave. At
this point communication between the master and the selected peripheral card is established, and data can flow in both directions simultaneously. The connection is maintained
so long as the master asserts the select signal.
User’s Manual
165
E.3 Function Calls
The function calls described in this section are used with all RabbitNet peripheral cards,
and are available in the RNET.LIB library in the Dynamic C LIB\RABBITNET folder.
rn_init
int rn_init(char portflag, char servicetype);
DESCRIPTION
Resets, initializes, or disables a specified RabbitNet port on the master single-board
computer. During initialization, the network is enumerated and relevant tables are filled
in. If the port is already initialized, calling this function forces a re-enumeration of all
devices on that port.
Call this function first before using other RabbitNet functions.
PARAMETERS
portflag
a bit that represents a RabbitNet port on the master single-board
computer (from 0 to the maximum number of ports). A set bit requires a service. If portflag = 0x03, both RabbitNet ports 0 and
1 will need to be serviced.
servicetype
enables or disables each RabbitNet port as set by the port flags.
0 = disable port
1 = enable port
RETURN VALUE
0
166
RabbitCore RCM3309/RCM3319
rn_device
int rn_device(char pna);
DESCRIPTION
Returns an address index to device information from a given physical node address. This
function will check device information to determine that the peripheral card is connected
to a master.
PARAMETER
pna
the physical node address, indicated as a byte.
7,6—2-bit binary representation of the port number on the master
5,4,3—Level 1 router downstream port
2,1,0—Level 2 router downstream port
RETURN VALUE
Pointer to device information.
-1 indicates that the peripheral card either cannot be identified or is not connected to the
master.
SEE ALSO
rn_find
User’s Manual
167
rn_find
int rn_find(rn_search *srch);
DESCRIPTION
Locates the first active device that matches the search criteria.
PARAMETER
srch
the search criteria structure rn_search:
unsigned int flags;
unsigned int ports;
char productid;
char productrev;
char coderev;
long serialnum;
//
//
//
//
//
//
status flags see MATCH macros below
port bitmask
product id
product rev
code rev
serial number
Use a maximum of 3 macros for the search criteria:
RN_MATCH_PORT
RN_MATCH_PNA
RN_MATCH_HANDLE
RN_MATCH_PRDID
RN_MATCH_PRDREV
RN_MATCH_CODEREV
RN_MATCH_SN
//
//
//
//
//
//
//
match
match
match
match
match
match
match
port bitmask
physical node address
instance (reg 3)
id/version (reg 1)
product revision
code revision
serial number
For example:
rn_search newdev;
newdev.flags = RN_MATCH_PORT|RN_MATCH_SN;
newdev.ports = 0x03; //search ports 0 and 1
newdev.serialnum = E3446C01L;
handle = rn_find(&newdev);
RETURN VALUE
Returns the handle of the first device matching the criteria.
0 indicates no such devices were found.
SEE ALSO
rn_device
168
RabbitCore RCM3309/RCM3319
rn_echo
int rn_echo(int handle, char sendecho, char *recdata);
DESCRIPTION
The peripheral card sends back the character the master sent. This function will check device information to determine that the peripheral card is connected to a master.
PARAMETERS
handle
an address index to device information. Use rn_device() or
rn_find() to establish the handle.
sendecho
the character to echo back.
recdata
pointer to the return address of the character from the device.
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master.
User’s Manual
169
rn_write
int rn_write(int handle, int regno, char *data, int datalen);
DESCRIPTION
Writes a string to the specified device and register. Waits for results. This function will
check device information to determine that the peripheral card is connected to a master.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
regno
is the command register number as designated by each device.
data
is a pointer to the address of the string to write to the device.
datalen
is the number of bytes to write (0–15).
NOTE: A data length of 0 will transmit the one-byte command register number.
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master, and -2 means that the data length was greater than 15.
SEE ALSO
rn_read
170
RabbitCore RCM3309/RCM3319
rn_read
int rn_read(int handle, int regno, char *recdata, int datalen);
DESCRIPTION
Reads a string from the specified device and register. Waits for results. This function will
check device information to determine that the peripheral card is connected to a master.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
regno
is the command register number as designated by each device.
recdata
is a pointer to the address of the string to read from the device.
datalen
is the number of bytes to read (0–15).
NOTE: A data length of 0 will transmit the one-byte command register number.
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master, and -2 means that the data length was greater than 15.
SEE ALSO
rn_write
User’s Manual
171
rn_reset
int rn_reset(int handle, int resettype);
DESCRIPTION
Sends a reset sequence to the specified peripheral card. The reset takes approximately
25 ms before the peripheral card will once again execute the application. Allow 1.5
seconds after the reset has completed before accessing the peripheral card. This function will check peripheral card information to determine that the peripheral card is connected to a master.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
resettype
describes the type of reset.
0 = hard reset—equivalent to power-up. All logic is reset.
1 = soft reset—only the microprocessor logic is reset.
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master.
172
RabbitCore RCM3309/RCM3319
rn_sw_wdt
int rn_sw_wdt(int handle, float timeout);
DESCRIPTION
Sets software watchdog timeout period. Call this function prior to enabling the software
watchdog timer. This function will check device information to determine that the peripheral card is connected to a master.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
timeout
is a timeout period from 0.025 to 6.375 seconds in increments of
0.025 seconds. Entering a zero value will disable the software
watchdog timer.
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master.
User’s Manual
173
rn_enable_wdt
int rn_enable_wdt(int handle, int wdttype);
DESCRIPTION
Enables the hardware and/or software watchdog timers on a peripheral card. The software on the peripheral card will keep the hardware watchdog timer updated, but will hard
reset if the time expires. The hardware watchdog cannot be disabled except by a hard
reset on the peripheral card. The software watchdog timer must be updated by software
on the master. The peripheral card will soft reset if the timeout set by rn_sw_wdt()
expires. This function will check device information to determine that the peripheral card
is connected to a master.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
wdttype
0 enables both hardware and software watchdog timers
1 enables hardware watchdog timer
2 enables software watchdog timer
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master.
SEE ALSO
rn_hitwd, rn_sw_wdt
174
RabbitCore RCM3309/RCM3319
rn_hitwd
int rn_hitwd(int handle, char *count);
DESCRIPTION
Hits software watchdog. Set the timeout period and enable the software watchdog prior
to using this function. This function will check device information to determine that the
peripheral card is connected to a master.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
count
is a pointer to return the present count of the software watchdog
timer. The equivalent time left in seconds can be determined from
count × 0.025 seconds.
RETURN VALUE
The status byte from the previous command.
-1 means that device information indicates the peripheral card is not connected to the
master.
SEE ALSO
rn_enable_wdt, rn_sw_wdt
User’s Manual
175
rn_rst_status
int rn_rst_status(int handle, char *retdata);
DESCRIPTION
Reads the status of which reset occurred and whether any watchdogs are enabled.
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
retdata
is a pointer to the return address of the communication byte. A set
bit indicates which error occurred. This register is cleared when
read.
7—HW reset has occurred
6—SW reset has occurred
5—HW watchdog enabled
4—SW watchdog enabled
3,2,1,0—Reserved
RETURN VALUE
The status byte from the previous command.
176
RabbitCore RCM3309/RCM3319
rn_comm_status
int rn_comm_status(int handle, char *retdata);
PARAMETERS
handle
is an address index to device information. Use rn_device() or
rn_find() to establish the handle.
retdata
is a pointer to the return address of the communication byte. A set
bit indicates which error occurred. This register is cleared when
read.
7—Data available and waiting to be processed MOSI (master
out, slave in)
6—Write collision MISO (master in, slave out)
5—Overrun MOSI (master out, slave in)
4—Mode fault, device detected hardware fault
3—Data compare error detected by device
2,1,0—Reserved
RETURN VALUE
The status byte from the previous command.
User’s Manual
177
E.3.1 Status Byte
Unless otherwise specified, functions returning a status byte will have the following format
for each designated bit.
7
×
6
5
4
3
2
1
0
00 = Reserved
01 = Ready
10 = Busy
11 = Device not connected
×
0 = Device
1 = Router
×
0 = No error
×
1 = Communication error*
Reserved for individual peripheral
cards
×
Reserved for individual peripheral
cards
×
0 = Last command accepted
1 = Last command unexecuted
×
×
0 = Not expired
1 = HW or SW watchdog timer
expired†
* Use the function rn_comm_status() to determine which error occurred.
† Use the function rn_rst_status() to determine which timer expired.
178
RabbitCore RCM3309/RCM3319
INDEX
A
additional information
online documentation .......... 7
B
battery backup
circuit .............................. 160
external battery connections ............................ 159
reset generator ................. 161
use of battery-backed SRAM
....................................... 38
board initialization
function calls ..................... 40
brdInit() ......................... 40
bus loading ............................ 73
C
clock doubler ........................ 33
conformal coating ................. 80
connectivity interface kits
Connector Adpater Board ... 7
Connector Adapter Board ....... 7
D
Development Kit ..................... 9
AC adapter .......................... 6
DC power supply ................ 6
programming cable ............. 6
RCM3309/RCM3319 .......... 6
Getting Started instructions .............................. 6
digital I/O .............................. 22
function calls
digIn() ............................ 41
digOut() ......................... 42
I/O buffer sourcing and sinking limits ....................... 77
memory interface .............. 27
SMODE0 .......................... 30
SMODE1 .......................... 30
User’s Manual
digital inputs
switching threshold ........... 90
dimensions
LCD/keypad module ....... 103
LCD/keypad template ..... 106
Prototyping Board ............. 85
RCM3309/RCM3319 ........ 68
Dynamic C .............. 7, 9, 13, 35
add-on modules ............. 9, 49
installation ....................... 9
battery-backed SRAM ...... 38
libraries
RCM33xx.LIB .............. 40
RN_CFG_RCM33.LIB . 40
protected variables ............ 38
Rabbit Embedded Security
Pack ................ 7, 9, 49, 63
sample programs ............... 16
standard features
debugging ...................... 36
telephone-based technical
support ...................... 7, 49
upgrades and patches ........ 49
E
Ethernet cables ...................... 51
how to tell them apart ....... 51
Ethernet connections ....... 51, 53
10/100Base-T .................... 53
10Base-T Ethernet card .... 51
additional resources .......... 65
direct connection ............... 53
Ethernet cables .................. 53
IP addresses ................. 53, 55
MAC addresses ................. 56
steps .................................. 52
Ethernet port ......................... 29
function calls
pd_powerdown() ........... 29
pd_powerup() ................ 29
pinout ................................ 29
powerdown ........................ 29
exclusion zone ...................... 69
external I/O bus .................... 27
software ....................... 27, 38
F
features .................................... 2
comparison with RCM3305/
RCM3315 ....................... 4
Prototyping Board ....... 82, 83
flash memory addresses
user blocks ........................ 34
H
hardware connections
install RCM3309/RCM3319
on Prototyping Board ... 10
power supply ..................... 12
programming cable ........... 11
hardware reset ....................... 12
headers
Prototyping Board
JP3 ................................. 92
JP5 ................................. 95
I
I/O address assignments
LCD/keypad module ....... 107
I/O buffer sourcing and sinking
limits ............................. 77
IP addresses .......................... 55
how to set in sample programs
....................................... 60
how to set PC IP address .. 61
179
J
L
jumper configurations
Prototyping Board
JP1 (RS-485 bias and termination resistors) ..........95
JP1 (stepper motor power
supply) ........................99
JP2 (stepper motor power
supply) ........................99
JP3 (quadrature decoder/serial flash) .....................99
JP4 (RCM3309/RCM3319
power supply) .............99
JP5 (RS-485 bias and termination resistors) ..........99
stepper motor power supply
.....................................97
RCM3309/RCM3319 ........78
JP1 (not stuffed) ............78
JP10 (PD3 or TPO+ Output
on J61 pin 30) .............79
JP11 (flash memory size)
.....................................79
JP12 (flash memory bank
select) ....................34, 79
JP13 (data SRAM size) .79
JP14 (LED DS1 display) 79
JP2 (ACT or PD1 Output on
J61 pin 34) ..................78
JP3 (LINK or PD0 Output
on J61 pin 33) .............78
JP4 (ENET or PE0 Output
on J62 pin 19) .............78
JP5 (NAND flash chip
enable) ........................78
JP7 (PD6 or TPO– Input on
J61 pin 31) ..................79
JP8 (PD7 or TPI+ Input on
J61 pin 32) ..................79
JP9 (PD2 or TPO– Output
on J61 pin 29) .............79
jumper locations ............78
LCD/keypad module
bezel-mount installation ..109
dimensions .......................103
function calls
dispInit() ......................113
header pinout ...................107
I/O address assignments ..107
keypad
function calls
keyConfig() ..............152
keyGet() ...................154
keyInit() ...................151
keypadDef() .............156
keyProcess() ............154
keyScan() .................157
keyUnget() ...............155
keypad template ..............106
LCD display
function calls
glBackLight() ..........115
glBlankRegion() ......120
glBlankScreen() .......117
glBlock() ..................121
glBuffLock() ............131
glBuffUnlock() ........131
glDispOnOff() .........116
glDown1() ................139
glFastFillRegion() ....119
glFillCircle() ............125
glFillPolygon() ........124
glFillRegion() ..........118
glFillScreen() ...........117
glFillVPolygon() ......123
glFontCharAddr() ....127
glGetBrushType() ....133
glGetPfStep() ...........128
glHScroll() ...............140
glInit() ......................115
glLeft1() ...................136
glPlotCircle() ...........125
glPlotDot() ...............135
glPlotLine() ..............135
glPlotPolygon() ........122
glPlotVPolygon() .....121
glPrintf() ..................130
glPutChar() ..............129
glPutFont() ...............127
glRight1() ................137
glSetBrushType() ....132
glSetContrast() .........116
glSetPfStep() ............128
glSwap() ..................132
K
keypad template ..................106
removing and inserting label
......................................106
180
glUp1() ....................138
glVScroll() ...............141
glXFontInit() ............126
glXGetBitmap() .......133
glXGetFastmap() .....134
glXPutBitmap() .......142
glXPutFastmap() ......143
TextBorder() ............146
TextBorderInit() ......145
TextCursorLocation()
...............................147
TextGotoXY() .........146
TextMaxChars() ......150
TextPrintf() ..............149
TextPutChar() ..........148
TextWinClear() ........150
TextWindowFrame() 144
LEDs
function calls ...............114
displedOut() .............114
mounting instructions ......108
reconfigure keypad ..........106
remote cable connection ..111
removing and inserting keypad
label .............................106
sample programs .............112
specifications ...................104
versions ...........................103
voltage settings ................105
LED (Prototyping Board)
function calls
ledOut() .........................44
LEDs (RCM3309/RCM3319)
Ethernet status ...................29
other LEDs ........................27
M
MAC addresses .....................56
mounting instructions
LCD/keypad module .......108
P
peripheral cards
connection to master 163, 164
pinout
Ethernet port ......................29
LCD/keypad module .......107
RCM3309/RCM3319
alternate configurations .24
RCM3309/RCM3319 headers
.......................................22
power supplies
+5 V .................................159
battery backup .................159
RabbitCore RCM3309/RCM3319
Program Mode ...................... 31
switching modes ............... 31
programming cable
PROG connector ............... 31
RCM3309/RCM3319 connections .............................. 11
programming port ................. 30
Prototyping Board ................. 82
adding components ........... 89
dimensions ........................ 85
expansion area ................... 83
features ........................ 82, 83
jumper configurations ....... 99
jumper locations ................ 98
mounting RCM3309/
RCM3319 ..................... 10
power supply ..................... 87
prototyping area ................ 89
specifications .................... 86
use of parallel ports ......... 100
R
Rabbit 3000
data and clock delays ........ 75
spectrum spreader time delays
....................................... 75
Rabbit subsystems ................ 23
RabbitNet
Ethernet cables to connect peripheral cards ...... 163, 164
function calls
rn_comm_status() ........ 177
rn_device() .................. 167
rn_echo() ..................... 169
rn_enable_wdt() .......... 174
rn_find() ...................... 168
rn_hitwd() .................... 175
rn_init() ....................... 166
rn_read() ...................... 171
rn_reset() ..................... 172
rn_rst_status() .............. 176
rn_sw_wdt() ................ 173
rn_write() .................... 170
general description .......... 163
peripheral cards ............... 164
A/D converter .............. 164
D/A converter .............. 164
digital I/O .................... 164
display/keypad interface ........................... 164
relay card ..................... 164
physical implementation . 165
RabbitNet port ................... 95
User’s Manual
RabbitNet port
function calls ..................... 47
rn_sp_close() ................. 48
rn_sp_disable() .............. 48
rn_sp_enable() ............... 48
rn_sp_info() ................... 47
software
macros ........................... 47
RCM3309/RCM3319
comparison with RCM3305/
RCM3315 ....................... 4
mass storage options ........... 2
mounting on Prototyping
Board ............................ 10
relay
function calls
relayOut() ...................... 45
reset ....................................... 12
use of reset pin ................ 161
RS-485 network
termination and bias resistors ................................ 95
Run Mode ............................. 31
switching modes ............... 31
S
sample programs ................... 16
FAT file system
FMT_DEVICE.C .......... 63
getting to know the
RCM3309/RCM3319
CONTROLLED.C ........ 16
FLASHLED1.C ............ 16
SWRELAY.C ................ 16
TOGGLESWITCH.C .... 16
how to run TCP/IP sample
programs ................. 59, 60
how to set IP address ........ 60
how to use non-RCM3309/
RCM3319 RabbitNet sample programs ................. 19
LCD/keypad module . 19, 112
KEYBASIC.C ............. 106
KEYPADTOLED.C .... 112
LCDKEYFUN.C ......... 112
reconfigure keypad ...... 106
SWITCHTOLCD.C .... 112
module integration ............ 63
INTEGRATION.C ........ 64
INTEGRATION_FAT_
SETUP.C .................... 64
onboard serial flash
SFLASH_INSPECT.C .. 17
SFLASH_LOG.C .......... 17
PONG.C ............................ 13
RabbitNet .......................... 19
real-time clock
RTC_TEST.C ................ 19
SETRTCKB.C .............. 19
Remote Application Update
DLP_STATIC.C ..... 37, 63
DLP_WEB.C .......... 37, 63
serial communication
FLOWCONTROL.C ..... 17
PARITY.C .................... 17
SIMPLE3WIRE.C ........ 18
SIMPLE485MASTER.C 19
SIMPLE485SLAVE.C .. 19
SIMPLE5WIRE.C ........ 18
SWITCHCHAR.C ........ 18
SF1000 serial flash card
SERFLASHTEST.C ..... 17
TCP/IP
BROWSELED.C .......... 62
DISPLAY_MAC.C ....... 56
MBOXDEMO.C ........... 62
PINGLED.C .................. 62
PINGME.C .................... 62
RabbitWeb
BLINKLEDS.C ......... 63
DOORMONITOR.C . 63
SPRINKLER.C ......... 63
SMTP.C ........................ 63
user-programmable LED
CONTROLLEDS.C ...... 27
FLASHLEDS.C ............ 27
serial communication ............ 28
function calls
ser485Rx() ..................... 46
ser485Tx() ..................... 46
Prototyping Board
RS-232 .......................... 93
RS-485 termination and bias
resistors ...................... 95
serial port configurations ............................ 92
RabbitNet port .................. 95
serial flash memory
formatting ......................... 39
serial ports ............................. 28
Ethernet port ..................... 29
programming port ............. 30
Prototyping Board ............. 92
181
software ...................................7
external I/O bus .................38
I/O drivers .........................38
libraries
KEYPAD7.LIB ...........151
LCD122KEY7.LIB
...........................113, 114
PACKET.LIB ................39
RCM33XX.LIB .............40
RN_CFG_RCM33.LIB .40
RNET.LIB ...................166
RS232.LIB .....................39
serial flash ......................39
TCP/IP ...........................39
power down Ethernet chip .29
sample programs ...............16
serial communication drivers
........................................39
serial flash drivers .............39
TCP/IP drivers ...................39
specifications .........................67
bus loading ........................73
digital I/O buffer sourcing and
sinking limits .................77
dimensions .........................68
electrical, mechanical, and environmental ...................70
exclusion zone ...................69
header footprint .................72
headers ...............................72
LCD/keypad module
dimensions ...................103
electrical ......................104
header footprint ...........104
mechanical ...................104
relative pin 1 locations 104
temperature ..................104
Prototyping Board .............86
Rabbit 3000 DC characteristics .................................76
Rabbit 3000 timing diagram
........................................74
relative pin 1 locations ......72
182
spectrum spreader .................75
settings ...............................33
status byte ............................178
subsystems
digital inputs and outputs ..22
switches
function calls
switchIn() .......................43
switching modes ....................31
T
TCP/IP primer .......................53
technical support ...................14
troubleshooting
changing COM port ...........13
connections ........................13
U
user block
function calls
readUserBlock() ............34
writeUserBlock() ...........34
RabbitCore RCM3309/RCM3319
SCHEMATICS
090-0253 RCM3309 Schematic
www.rabbit.com/documentation/schemat/090-0253.pdf
090-0188 Prototyping Board Schematic
www.rabbit.com/documentation/schemat/090-0188.pdf
090-0156 LCD/Keypad Module Schematic
www.rabbit.com/documentation/schemat/090-0156.pdf
090-0252 USB Programming Cable Schematic
www.rabbit.com/documentation/schemat/090-0252.pdf
You may use the URL information provided above to access the latest schematics directly.
User’s Manual
183
工商网监
湘ICP备2023018690号