Page is loading ...
NET+OS with Green Hills
BSP Porting Guide
Operating system/version: NET+OS 6.0
Part number/version: 90000333_B
Release date: March 2006
www.digi.com
NET+Works with Green Hills
BSP Porting Guide
©2006 Digi International Inc.
Printed in the United States of America. All rights reserved.
Digi, Digi International, the Digi logo, the Making Device Networking Easy logo, NetSilicon,
a Digi International Company, NET+, NET+OS and NET+Works are trademarks or registered trademarks of
Digi International, Inc. in the United States and other countries worldwide. All other trademarks are the
property of their respective owners.
Information is this document is subject to change without notice and does not represent a committment
on the part of Digi International.
Digi provides this document “as is,” without warranty of any kind, either expressed or implied, including,
but not limited to, the implied warranties of, fitness or merchantability for a particular purpose. Digi
may make improvements and/or changes in this manual or in the product(s) and/or the program(s)
described in this manual at any time.
This product could include technical inaccuracies or typographical errors. Changes are made
periodically to the information herein; these changes may be incorporated in new editions
of the publication.
v
Chapter 1: BSP Overview .................................................................................. 1
Overview ........................................................................................................................2
Hardware reset ..............................................................................................................2
ROM startup...................................................................................................................3
ncc_init routine ....................................................................................................4
C library startup.............................................................................................................4
main routine......................................................................................................... 5
NABoardInit routine.....................................................................................................5
netosStartup routine ...........................................................................................6
Chapter 2: Processor Modes and Exceptions .................................9
Overview ...................................................................................................................... 10
Vector table................................................................................................................... 10
IRQ handler .................................................................................................................. 11
Servicing interrupts........................................................................................... 12
Changing interrupt priority............................................................................. 13
Interrupt sources and default priorities................................................................... 13
Interrupt service routines........................................................................................... 14
FIQ handlers................................................................................................................. 15
Installing a FIQ handler.................................................................................... 15
Contents
vi
Chapter 3: Customizing the BSP
for Application Hardware .................................................. 17
Overview ...................................................................................................................... 18
Before you begin.......................................................................................................... 18
Task 1: Purchase Ethernet MAC addresses from the IEEE ................................... 19
Task 2: Create a new platform directory ................................................................. 20
Task 3: Modify the BSP configuration settings ....................................................... 21
Task 4: Create a build file for your platform........................................................... 21
Task 5: Modify the linker scripts............................................................................... 23
Bootloader considerations ............................................................................... 23
Task 6: Modify the new BSP for the application hardware .................................. 24
Phase Lock Loop ............................................................................................... 24
Memory timing settings................................................................................... 25
Chip select settings ........................................................................................... 25
General purpose I/O settings ......................................................................... 27
Ethernet PHY..................................................................................................... 29
Simple serial driver........................................................................................... 30
Task 7: Modify the format of BSP arguments in NVRAM.................................... 30
Task 8: Modify error and exception handlers......................................................... 31
Task 9: Create the debugger initialization files....................................................... 32
Task 10: Debug the initialization code from RAM................................................. 34
Working with a locked-up ICE ....................................................................... 34
Preparing to debug ........................................................................................... 35
Debugging the initialization code .................................................................. 36
Task 11: Debug the initialization code from ROM................................................. 39
Verify processor bootstrap values .................................................................. 40
Debug the ncc_init routine .............................................................................. 41
Task 12: Modify the Startup dialog .......................................................................... 42
Task 13: Modify the POST ......................................................................................... 43
Task 14: Modify the ACE ........................................................................................... 43
vii
Chapter 4: Device Drivers ..............................................................................45
Overview ...................................................................................................................... 46
Adding devices ............................................................................................................ 46
deviceInfo structure ....................................................................................................46
Device driver functions .............................................................................................. 48
deviceEnter ..........................................................................................................49
deviceInit .............................................................................................................50
deviceOpen ..........................................................................................................51
deviceClose .........................................................................................................53
deviceConfig .......................................................................................................54
deviceRead ..........................................................................................................55
deviceWrite ..........................................................................................................57
deviceIoctl ...........................................................................................................59
Modifications to the Green Hills system library..................................................... 60
Making modifications....................................................................................... 60
Chapter 5: Updating Flash Support ....................................................... 61
Overview ...................................................................................................................... 62
Flash table data structure ........................................................................................... 63
Adding new flash ........................................................................................................ 65
Supporting larger flash............................................................................................... 66
Chapter 6: Bootloader Utility Overview............................................ 67
Overview ...................................................................................................................... 68
Bootloader application images .................................................................................. 68
ROM image ........................................................................................................ 69
RAM image ........................................................................................................ 69
Application image structure ......................................................................................70
Application image header................................................................................ 70
Boothdr utility.............................................................................................................. 72
Generating an image................................................................................................... 73
Configuration file .............................................................................................. 73
viii
Chapter 7: Customizing the Bootloader Utility ......................... 75
Overview ...................................................................................................................... 76
Customization hooks.................................................................................................. 76
NABlReportError ................................................................................................ 77
getMacAddress ................................................................................................... 78
isImageValid ....................................................................................................... 79
shouldDownloadImage ....................................................................................... 80
getDefaultFilename ............................................................................................. 81
downloadImage ................................................................................................... 82
Chapter 8: Linker Files...................................................................................... 83
Overview ...................................................................................................................... 84
Linker files provided for sample projects................................................................ 84
Green Hills section of the linker files ............................................................. 85
NET+OS section of the linker files.................................................................. 86
Memory aliasing in NET+OS .................................................................................... 86
Address mapping.............................................................................................. 88
Chapter 9: Hardware Dependencies ...................................................... 89
Overview ...................................................................................................................... 90
DMA channels ............................................................................................................. 90
Ethernet PHY ............................................................................................................... 91
ENI controller .............................................................................................................. 91
Serial ports....................................................................................................................92
Software watchdog ..................................................................................................... 92
Big Endian mode ......................................................................................................... 92
System clock................................................................................................................. 92
PLLTST_SELECT............................................................................................... 93
XTAL1_FREQUENCY...................................................................................... 93
CRYSTAL_OSCILLATOR_FREQUENCY..................................................... 93
PLL_CONTROL_REGISTER_N_VALUE...................................................... 94
ix
System timers ...............................................................................................................94
Timer 1 ................................................................................................................ 94
Timer 2 ................................................................................................................ 94
Interrupts ......................................................................................................................95
Memory map................................................................................................................ 96
Using This Guide
xi
Review this section for basic information about the guide you are using, as well
as general support and contact information.
About this guide
This guide provides general information for porting the NET+Works for NET+OS
board support package (BSP) to a new hardware platform based on the Digi
development board.
NET+OS, a network software suite optimized for the NET+ARM devices, is part
of the NET+Works integrated product family.
Software release
This guide supports NET+OS 6.0. By default, this software is installed in the
C:\NETOS60_GH361\ directory.
Who should read this guide
This guide is for engineers who are developing applications with NET+OS.
To complete the tasks described in this guide, you must:
Be familiar with installing and configuring network software and
development board systems
Have sufficient system or user privileges to do these tasks
xii
NET+Works with Green Hills BSP Porting Guide
What’s in this guide
This table shows where you can find specific information in this guide:
Conventions used in this guide
This table describes the typographic conventions used in this guide:
To read about See
The BSP and how it works Chapter 1, “BSP Overview”
The modes in which NET+OS operates, and
how interrupts are handled
Chapter 2, “Processor Modes and
Exceptions”
How to modify the BSP to support your
application hardware
Chapter 3, “Customizing the BSP for
Application Hardware”
Device driver functions and device definitions Chapter 4, “Device Drivers”
Adding new flash ROM parts to the existing
table of supported flash ROM parts
Chapter 5, “Updating Flash Support”
What the bootloader utility is Chapter 6, “Bootloader Utility
Overview”
How to customize the bootloader utility to
support your applications
Chapter 7, “Customizing the
Bootloader Utility”
The linker files provided for sample projects,
including basic Green Hills and NET+OS
sections of the linker files
Chapter 8, “Linker Files”
Hardware dependencies for porting NET+OS
to your application hardware
Chapter 9, “Hardware Dependencies”
This convention Indicates
italic type
Emphasis, new terms, variables, and document titles.
Select menu menu
option
or options.
Menu selections. The first word is the menu name; the
words that follow are menu selections.
monospaced type
Filenames, pathnames, and code examples.
www.digi.com
xiii
Related documentation
The Quick Installation Guide explains how to install the hardware.
NET+Works with Green Hills Programmer’s Guide describes how to use
NET+OS to develop programs for your application and hardware.
The NET+Works online help provides reference information on the
NET+OS application programming interfaces (APIs).
Review the documentation CD-ROM that came with your development kit for
information on third-party products and other components.
For information on the processor you are using, see the NET+Works hardware
documentation.
Customer support
To get help with a question or technical problem with this product, or to make
comments and recommendations about our products or documentation, use this
contact information:
United State telephone: 1 877 912-3444
International telephone: 1 952 912-3444
email: [email protected]
Web site: http://digi.com
1
BSP Overview
CHAPTER 1
This chapter provides general information about the NET+OS Board Support
Package (BSP) and how it operates.
2
NET+Works with Green Hills BSP Porting Guide
Overview
The BSP consists of the hardware-dependent parts of the real-time operating
system (RTOS), which includes:
Initializing the hardware after a hard reset or a restart
Exception handling
Device drivers
Starting the ThreadX kernel
Starting the TCP/IP stack
The NET+OS BSP that is provided with the NET+Works development kit is
designed to work on NET+Works development boards. Because most user
applications require custom hardware, you will need to modify the NET+OS
BSP to work correctly on your application hardware.
The rest of this chapter describes how the BSP initializes the hardware.
Hardware reset
At startup, the NET+ARM reads the state of all external address lines to determine
how to configure itself. All NET+ARM address lines have input current sources,
so that if left unchanged, the address lines are in the high state.
Hardware configuration settings are implemented through pull-up and pull-
down resistors attached to these pins.
NET+OS requires these configuration settings:ET+OS requires these configuration
settings:
Configuration Address Mode State
Endian A27 Big Endian High
CPU bootstrap A28 ARM CPU enabled High
www.digi.com
3
At startup, the NET+ARM performs this process:
1 Resets all internal devices
2 Disables all chip selects except CS0
3 Configures CS0 to map the contents of the ROM to all memory
4 Disables cache
At reset, the ARM processor core does this:
1 Enables ARM mode
2 Sets Supervisor mode
3 Disables IRQ and FIQ interrupts
4 Sets the program counter (PC) to 0
5 Starts executing at 0 (512 clocks after reset is de-asserted)
ROM startup
After a hardware reset, the first code executed is in
C:\NETOS60_GH361\src\bsp\common\reset.s. This code jumps to the routine
Reset_Handler_Rom, located in C:\NETOS60_GH361\src\bsp\arm7init\init.s,
which performs this process:
1 Sets the processor mode and disables all interrupts.
2 Initializes the phase lock loop (PLL) on the NET+50.
3 Sets the BSPEED field in the System Control register to enable full
bus speed.
4 Executes a soft reset.
5 Places the direct memory access (DMA) controller into test mode.
The on-chip static RAM, which normally stores DMA context information and
register values, becomes available as RAM.
6 Sets the SVC stack pointer to point to the DMA RAM.
7 Calls the ncc_init routine to initialize the application hardware.
8 Sets up stacks for all processor modes.
4
NET+Works with Green Hills BSP Porting Guide
9 Releases the DMA controller from test mode.
10 Calls the C library startup routines. These routines do not return.
ncc_init routine
To complete the basic hardware initialization of the system, Reset_Handler_Rom
calls the
ncc_init routine. The routine performs this process:
1 Calls customizeSetupMMCR to set the Memory Management Control register.
2 Calls customizeGetScr to set the System Control register.
3 Determines whether a software restart has occurred.
4 Determines whether a debugger is attached.
5 Calls the customizeSetupPortX routines to set up the general-purpose I/O
(GPIO) ports.
6 Calls customizeSetupCS0 to set up CS0.
7 Sets up the other chip selects.
If a startup reset has occurred, all the chip selects are initialized. Otherwise, the
default implementation assumes that the RAM chip selects have already been
set up and reinitializes only
CS3, which is normally used to support non-
volatile RAM (NVRAM).
8 Calls customizeReadPowerOnButtons to read and save the state of buttons and
jumpers.
9 Verifies that the application can fit in available RAM.
10 Sets flags in memory (which is now set up) to indicate whether a debugger is
present and whether a software reset has occurred.
C library startup
The C library startup sets up the C runtime environment in two steps:
1 Copies initialized data from ROM to RAM, and resets uninitialized data to 0.
2 Calls the main routine.
www.digi.com
5
main routine
After the C runtime environment is set up, the C runtime code calls the main
routine. The
main routine performs this process:
1 Calls customizeSetupLedTable to initialize the LED driver
2 Executes a power-on self-test (POST) if a hard reset has occurred and APP_POST is
set
3 Sets up the system vector table
4 Calls NABoardInit to shut down DMA, the Ethernet media access controller
(MAC), ENI, and serial ports; initialize the low-level flash and NVRAM APIs; and
turn on cache if the NET+ARM supports it.
5 Calls DDIFirstLevelInitilize to perform preliminary initialization of system
device drivers
6 Calls NAGetAppCpp, which initializes the C++ runtime environment if APP_CPP is
defined
7 Calls tx_kernel_enter to start the ThreadX kernel
NABoardInit routine
The NABoardInit routine in the narmbrd.c file performs this process:
1 Reads the chip revision and stores it in the g_NAChipRevision global variable
2 Shuts down all DMA channels, as well as the Ethernet controller and all serial ports
3 Masks all interrupts
4 Initializes the flash and NVRAM read and write APIs
5 Calls NACacheSetDefaults to initialize and turn on cache
6
NET+Works with Green Hills BSP Porting Guide
netosStartup routine
The startup sequence is completed in the netosStartup routine, which performs
these steps:
1 Sets up the semaphores that the flash driver uses in a multithreaded environment.
2 Sets up the sleep function that the NAWait function uses.
3 Loads default NVRAM parameters from the appconf.h file.
4 Calls DDISecondLevelInitialize to load the system device drivers.
This function calls the
deviceInit function defined for each device in the
device table.
5 Creates the TCP timer thread to trigger calls to tcp_down_function, which calls
the
TcpDown application each second.
6 Calls customizeDialog to prompt the user with a configuration dialog box.
7 Calls netosConfigStdio.
If
APP_STDIO_PORT is defined in appconf.h as a valid device name,
netosConfigStdio redirects stdin, stdout, and stderr to the
indicated device.
8 Starts the time APIs and sets the time zone to the value stored in NVRAM, which is
EST by default.
9 Calls filesystem_init if BSP_INCLUDE_FILESYSTEM_For_CLIBRARY is
defined as
1. The filesystem_init call initializes the filesystem for C library file
functions.
10 Calls netosStartTCP to create and initialize resources (for example, semaphores
and memory), and to start up all threads required by the
TCP/IP stack.
The Address Configuration Executive (ACE) is used to set the IP parameters.
The parameters may be stacked in NVRAM, or the ACE may set them from the
network.
The application startup is delayed
BSP_STARTUP_DELAY seconds.
(
BSP_STARTUP_DELAY is defined in bspconf.h.)
11 Calls TcpDown once every tick until the TCP/IP stack is initialized.
/
