CPCI-910 Programmer's Guide - Emerson Network Power

CPCI-910 

Programmer’s Guide 

P/N 221014 Revision AD 

April 2004

The information in this publication is subject to change without notice. Force Computers reserves the right to make changes without 

notice to this, or any of its products, to improve reliability, performance, or design. 

Force Computers shall not be liable for technical or editorial errors or omissions contained herein, nor for indirect, special, incidental, 

or consequential damages resulting from the furnishing, performance, or use of this material. This information is provided 

“as is” and Force Computers expressly disclaims any and all warranties, express, implied, statutory, or otherwise, including 

without limitation, any express, statutory, or implied warranty of merchantability, fitness for a particular purpose, or non-infringement. 

This publication contains information protected by copyright. This publication shall not be reproduced, transmitted, or stored in 

a retrieval system, nor its contents used for any purpose, without the prior written consent of Force Computers. 

Force Computers assumes no responsibility for the use of any circuitry other than circuitry that is part of a product of Force 

Computers. Force Computers does not convey to the purchaser of the product described herein any license under the patent 

rights of Force Computers nor the rights of others. 

Copyright© 2004 by Force Computers. All rights reserved. 

The Force logo is a trademark of Force Computers. 

Copyright 

IEEE is a registered trademark of the Institute for Electrical and Electronics Engineers, Inc. 

PICMG, CompactPCI, and the CompactPCI logo are registered trademarks and the PICMG logo is a trademark of the PCI Industrial 

Computer Manufacturer’s Group. 

MS-DOS, Windows95, Windows98, Windows2000 and Windows NT are registered trademarks and the logos are a trademark of 

the Microsoft Corporation. 

Intel and Pentium are registered trademarks and the Intel logo is a trademark of the Intel Corporation. 

StrongARM is a registered trademark of ARM, Limited. 

Linux is a registered trademark of Linus Torvalds. 

Broadcom is a registered trademark of the Broadcom Corporation. 

Other product names mentioned herein may be trademarks and/or registered trademarks of their respective companies.

221014 410 000 AD 

World Wide Web: www.forcecomputers.com 

24-hour access to on-line manuals, driver updates, and application 

notes is provided via SMART, our SolutionsPLUS customer support 

program that provides current technical and services information. 

Headquarters 

The Americas Europe Asia 

Corporate Headquarters/CA 

Force Computers 

4211 Starboard Drive 

Fremont, CA 94538 

Tel.: +1 510 624-8274 

Fax: +1 510 445-6007 

Email: support@fci.com 

Force Computers GmbH 

Lilienthalstr. 15 

D-85579 Neubiberg/München 

Germany 

Tel.: +49 (89) 608 14-0 

Fax: +49 (89) 609 77 93 

Email: support-de@fci.com 

Force Computers Japan KK 

Shibadaimon MF Building 4F 

2-1-16 Shiba Daimon 

Minato-ku, Tokyo 105-0012 Japan 

Tel.: +81 (03) 3437 6221 

Fax: +81 (03) 3437 6223 

Email: support-de@fci.com

Using This Manual 

Other Sources of Information 

1 Introduction 

Contents 

Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 

Software Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 

Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 

Linux Support Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 

Switching Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 

Packet Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 

JFFS Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 

JFFS Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5 

Message Passing Using Sentinel (PCI-PCI Bridge) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 

Watchdog Implementation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6 

Software Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 

BCM Demo Software and BCM CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1-7 

MAC Numbers in Boot Flash . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12 

Support for IXP1250 Microcode Development IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12 

2 API Call Reference 

CPCI-910 v

List of APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 

Virtual Local Area Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4 

Address Resolution Table Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8 

Filter Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14 

Steps To Create a Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20 

Register Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22 

MIIM APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23 

Interrupt Control APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24 

PCI Config Space . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25 

PCI Memory Mapped Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26 

Indirect Mapped Registers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27 

Trunking (Link Aggregation) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28 

Trunk Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34 

Stacking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35 

PTABLE Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37 

Packet Driver APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38 

Port-Related APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-40 

Port Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54 

L3 Support APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57 

L3 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58 

L3 Interface Table Related APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58 

L3 Table APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-60 

L3 DEFIP Table APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64 

Multicast Table Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68 

Mirror APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-71 

CoSQ Management APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-75 

Flash API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-79 

Watchdog APIs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-79 

A Error Codes 

Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3 

B Project Configuration and Example Design 

Project Configuration and Example Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3 

Building Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-3 

Example Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6 

Modifying Example Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-6 

vi CPCI-910

Receive Processing for Receive Microengine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-6 

Transmitting Packets for Receive Microengine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-7 

Transmitting Packet Details for Transmit Microengine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .B-8 

Index of Functions 

Product Error Report 

CPCI-910 vii

viii CPCI-910

Figures 

Introduction 

Figure 1 Software Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7 

Figure 2 Architecture of BCM Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8 

API Call Reference 

Figure 3 Copper Daughter Card Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-56 

Figure 4 Fiber Optic Daughter Card Port Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57 

CPCI-910 vii

viii CPCI-910

Using This Manual 

Conventions 

Abbreviations 

This Programmer’s guide is for designers, developers, and system integrators 

who design and build CPCI-910 modules into application systems. 

Manufacturing and field technicians and support specialists can also use 

the information in this manual to help configure systems and diagnose 

problems. 

The guide assumes you have experience with system design and the 

module’s bus design and specifications. In addition, you must also be 

familiar with Linux TM Operating Systems both as a user and as a 

programmer. 

This manual describes how to use the dual stacked/cascaded Gigabit 

Multilayer Switch Broadcom BCM5680. 

Notation Description 

57 All numbers are decimal numbers except when used with the following 

notations: 

00000000 16 

0000 2 

Typical notation for hexadecimal numbers (digits are 0 through F), 

e.g. used for addresses and offsets. 

Same for binary numbers (digits are 0 and 1) 

Bold Character format used to emphasize a word 

Courier Character format used for user input/on-screen output 

Italics 

 

[text] 

Note: 

Character format for references and for table and figure descriptions. 

Typical notation used for variables and keys. 

Typical notation for buttons. 

No danger encountered. Pay attention to important information 

marked using this layout. 

API Application Programming Interface 

ARL Address Resolution Logic 

CPCI-910 ix

BIB Board Information Block 

CMIC CPU Management Interface Controller 

CoS Class of Service 

CPCI Compact PCI 

CRC Cyclic Redundancy Check 

DLF Destination Lookup Failure 

Flash Utility 

(FUtil) 

Utility to update Flash, available as part of Boot Manager 

FFP Fast Filter Processor 

IBMU Intelligent Base Board Management Unit 

IP Internet Protocol 

IPMI Intelligent Platform Management Interface 

JFSS Journalling Flash File System 

OS Operating System 

PCI Peripheral Component Interconnect Bus 

RFIFO Receive First in First Out 

SA Strong Arm 

SDK Software Development Kit 

SLF Source Lookup Failure 

SOP Start Of Packet 

TFTP Trivial File Transfer Protocol 

x CPCI-910

Revision History 

Document 

Number, P/N, or 

Order Number 

Document 

Number 19- 

0010-01 

P/N 

CPCI910PG 

Revision Date Description 

A June 2002 Initial Release 

B September 

2002 

CPCI910PG C November 

2002 

CPCI910PG D January 

2003 

Added IPMI Application Usage information 

Editorial changes 

Adopted SAP P/N with elimination of 

document number 

Added “Packet Driver” page 1-5 

Modified Figure 1 “Software Architecture” 

page 1-7 

Added “BCM Demo Software and BCM 

CLI” page 1-7 and “Packet Driver APIs” 

page 2-38 

Editorial Changes 

Address ranges modified in section 

“JFFS Support” page 1-5 

Added note under section “Linux Support 

Package” page 1-4 

Modified note in section “Packet Driver” 

page 1-5 

Modified Figure 2 “Architecture of BCM 

Software” page 1-8 

Modified note in section “List of APIs” 

page 2-3 

Removed all init APIs 

Added section “Steps To Create a Filter” 

page 2-20 

Added section “Trunk Usage” page 2-34 

Added section “Port Configurations” 

page 2-54 

CPCI-910 xi

Document 

Number, P/N, or 

Order Number 

Order Number 

221014 410 000 

Order Number 

221014 410 000 

Order Number 

221014 410 000 

Order Number 

221014 410 000 

Revision Date Description 

AA July 2003 Release F1.1 

Replaced P/N with Order Number 

Editorial Changes 

Changes made for F1.1 

AB September 

2003 

AC February 

2004 

Release F1.2. 

Added note for auto negotiation. 

Release F1.3 

Corrected information related to daughter 

card ports 

AD April 2004 Release F1.4 

Improved the status of APIs by adding 

include files 

Included new index 

xii CPCI-910

Other Sources of Information 

For further information refer to the following documents: 

Company URL Document 

Intel ® 

Broadcom ® 

www.intel.com Intel ® IXP 1200 Software development Kit 

version 2.0.1 documentation 

futil.txt and bootMgr.txt available with 

Boot Manager code 

Cygmon BSP for IXA SDK 2.0 User Guide 

Revision 1.3 

Cygmon_readme_ixm1200.doc available 

with Cygmon code 

README file for building Cygmon 

www.broadcom.com Broadcom ® 5680 Development Kit, 

version 3.0.1 documentation 

CPCI-910 xiii

xiv CPCI-910

1 

Introduction

Introduction Introduction 

Introduction 

Software Details 

Firmware 

CPCI-910 is a dual Intel IXP1250 Network Processor Compact Peripheral 

Component Interconnect (CompactPCI) board that can operate in the peripheral 

slot. It has two cascaded/stacked Broadcom Gigabit switches (BCM5680) to 

provide Layer 2 switching capabilities. CPCI-910 provides four Gigabit Ethernet 

Interfaces each through front panel, daughter card, RTB, and two Gigabit Ethernet 

Interfaces to the CompactPCI Packet Switching Backplane (PSB) which conforms 

to PICMG 2.16 standards. 

CPCI-910 Software consists of: 

• Firmware 

• Linux Support Package 

• Switching Software 

• Boot Firmware 

Firmware begins to execute after a cold or warm IXP 1250 reset. There is an initial 

boot phase, which is called Boot Manager, in Intel ® SDK terminology. This presents 

a menu using which the user may boot to any one of the following: 

– Cygmon 

– minilinux 

– Diagnostics 

– VxWorks 

Cygmon is a bootstrap loader firmware that enables booting Linux. 

• Diagnostics Firmware 

It is a menu-based set of utilities to diagnose the functionalities of various components 

on board. The health of components such as IXBus, IXF1002, IPMI, 

SDRAM and so on can be checked using this firmware. Diagnostics firmware can 

be invoked from Boot Manager command prompt. 

CPCI-910 1 - 3


Linux Support Package 

The Linux Support Package consists of the Linux kernel and driver modules such 

as: 

• BCM driver modules 

• Microengine modules 

• IXF 1002 Driver 

• peth Driver 

• Flash Driver 

• Montavista’s open IPMI Driver 

Switching Software 

Note: CPCI910 software does not support hotswap functionality in system 

slot. 

The OS image for both the Master and Slave IXP is derived from the same Linux 

source tree. Linux is aware of the Master Slave feature and is able to determine its 

role during run time using hardware registers. 

Linux Support Package can: 

• automatically detect if the IXP is monarch or Non-monarch at run time. 

• manage own devices such as serial port and Flash through standard Linux 

device drivers. 

• initialize and manage its own microengines and internal devices on the chip. 

• provide support for access to microengine features (based on Intel ® SDK 2.0). 

• support Journalling Flash File System (JFSS) for User Flash 

Note: PCI I/O access beyond bridge should always be 32-bit 

Switching Software consists of Broadcom 5680 Driver and CPCI-910 Switch APIs. 

The Switch APIs provide application writer-access to all hardware features of 

switch. Switch APIs are part of SDK module. The driver code uses API functions 

to initialize the switch. Driver module depends on SDK module for its loading. 

Note: Ensure that you refer to the latest Release Notes for current 

information and any changes. 

1 - 4 CPCI-910


Packet Driver 

JFFS Support 

JFFS Usage 

The packet driver is a pseudo Ethernet driver. It offers all the functions of typical 

Ethernet driver. This is visible in Linux as an Ethernet interface. The packet driver 

makes use of Gigabit switch APIs to send and receive packets to and from a network 

attached to Gigabit switch ports. Packets sent using this interface from Linux 

are sent to the Gigabit switch over PCI DMA. Packets destined for packet driver 

interface are also sent to it by the Gigabit switch over PCI DMA. This pseudo 

Ethernet interface has been named as bcmnet.The driver is shipped as part of 

Ramdisk. Following commands are needed to invoke packet driver action.: 

$insmod /lib/modules/bcmnet.o 

$ifconfig bcmnet up 

Note: The packet driver interface is not a high performance interface. The 

packet driver interface should be used only for control plane applications. 

Partitions made are: 

• Boot Partition from 0x0 - 0x80000 , which is not programmable. 

• Mini-linux partition from 0x200000 - 0x400000 

• Kernel partition from 0x420000 - 0x4e0000. 

• Ramdisk partition from 0x4e0000 - 0x800000. 

The MTD devices are /dev/mtd0,1,2,3 as character devices, and 

/dev/mtdblock0,1,2,3 are the corresponding block devices. Except for 

/dev/mtd0 and /dev/mtdblock0, all the other devices are write enabled. 

First read the file, /proc/mtd to see all the partitions.Use utility, mkfs.jffs 

in /cpci910 directory to create a JFFS file-system. 

Create a JFFS file system: 

# /redlion/eraseall /dev/mtd1[2, 3] 

Note: eraseall should be used only when the entire partition contents 

(JFFS) has to be removed. It is suggested to execute eraseall before first 

mount. 



Mount the jffs file system: 

#mount -t jffs /dev/mtdblock1(2 or 3) 

Unmount the JFFS file system: 

#umount 

For further details, please refer to mtd-jffs-HOWTO.txt available on Internet. 

Message Passing Using Sentinel (PCI-PCI Bridge) 

Sentinel is a universal PCI-to-PCI bridge. The most important feature is the dual 

nature. The CompactPCI signal SYSEN# is used to differentiate between slot 1(the 

system slot) and any other CompactPCI slot. This makes the board with Sentinel 

chip, compatible with any slot, and the Sentinel chip behaves in appropriate mode. 

Prerequisites The system slot board should be able to scan the peripheral board and should allocate 

a memory window to the device. 

Sentinel driver can work both in system slot and peripheral slot with messaging 

feature enabled. This driver basically enables sentinel chip to communicate with 

the system slot board. A sample code is provided for communicating with the sentinel 

in peripheral slot and any other board in the system slot. 

A system slot board can post messages to the peripheral board by writing into the 

Inbound Post List FIFO register in the Device specific register space of Peripheral 

Sentinel. This space has to be mapped into the memory and should not be used 

from configuration space. Whenever a message is posted, the sentinel on the 

peripheral board will generate an interrupt which will be serviced by the driver. 

Driver is responsible for reading the head pointer from the Inbound Post List FIFO 

register and should process all the messages in between the head pointer and the tail 

pointer. 

Watchdog Implementation 

The CPCI-910 board has implementation of watchdog, SHORTDOG, to monitor 

program execution in both the network processors, IXP-A and IXP-B. The Linux 

kernel provides APIs to arm, disarm, and refresh the shortdog for both IXP-A and 

IXP-B. 


Introduction Software Architecture 

Software Architecture 

BCM API DEMO 

APPLICATION 

bcm_appln 

BCM API DEMO 

MODULE 

bcm_mtest.o 

switchconfig 

FACTORY 

DEFAULT UTILITY 

bcmsdk.o 

BCM SDK MODULE 

*BCM 5680 

Figure 1: Software Architecture 

BCM Demo Software and BCM CLI 

The software architecture is shown below in Figure 1: 

frc_bcm_drv.o 

BCM DRIVER 

MODULE 

TCP/IP 

APPLICATIONS 

JFFS 

FLASH DRIVER 

LINUX TCP/IP STACK 

PACKET DRIVER 

IXP1250 

IXP1250 

*StrongARM TM CORE 

MICROCODE 

LOADER 

MICROENGINE 

DRIVER 

MICROCODE 

APPLICATION 

TCP/IP 

APPLICATIONS 

LINUX TCP/IP STACK 

*MICROENGINES 

PETH DRIVER 

IXF1002 DRIVER 

USER 

LEVEL 

LINUX 

KERNEL 

* Indicates names are registered trademarks and copyright of their respective manufacturers 

The BCM Demo Software has a modular architecture. It consists of a user level 

application, bcm_appln, provided as a command line interface and a kernel module 

(bcm_mtest.o). You can use the Command Line Interface (CLI) for configuring 

VLAN, Trunk etc. The architecture of the BCM Demo Software is shown in 

Figure 2 “Architecture of BCM Software” page 1-8. 

CPCI-910 1 - 7 

*IXF1002 

IPMI 

UTILITY 

Open IPMI Driver 

HARDWARE 

IPMI Firmware and 

Hardware

Software Architecture Introduction 

Invoking the BCM 

CLI 

USER 

SPACE 

KERNEL 

SPACE 

CLI 

(bcm_appln) 

ioctls 

Test Module 

(bcm_mtest.o) 

Figure 2:Architecture of BCM Software 

Factory default utility 

switchconfig 

Functional 

Interface 

(Exported 

Functions) 

BCM SDK Module 

bcmsdk.o 

CLI interacts with the test module through ioctls . The BCM driver is a 

character driver and consists of two subsections (API and Linux Character Driver). 

The API has functions for configuring VLAN, Stack, Trunk etc. and various 

initialization routines. BCM Driver exports all these functions to the Linux kernel. 

The test module invokes these exported functions. You can invoke the BCM CLI at 

the command prompt. The CLI is a menu driven and self explanatory application. 

At the Linux prompt type bcm_appln to invoke the BCM CLI. You will see the 

following output on screen: 

[root@Linux /root]$bcm_appln 

0 : EXIT TESTING 

1 : PCI 

2 : VLAN 

3 : Port based VLAN 

4 : ARL 

5 : TRUNK 

6 : STACK 

7 : FILTER -- FFP 

8 : READ REGISTER CONTENTS 

9 : MIIM Test 

10 : PORT 

11 : INTERRUPT 

12 : L3 

13 : COS 

14 : MULTICAST 

1 - 8 CPCI-910 

ioctl


15 : MIRROR 

Select the API to test[0 - 15]--> 

Refer to see the “API Call Reference” chapter for information on APIs. 

Factory Default Utility Switchconfig is a factory default utility to configure Broadcom switches on 

CPCI910 at boot time. Switchconfig executes from runlevel 3 init script and 

allows to configure VLANs, trunks, port, stacking, and so on by means of the 

default config file, config.bcm 

config.bcm provides the following options: 

• STACK 

This command allows to stack both switches on CPCI910. For details on stacking 

feature on Broadcom switches, please refer 'Theory of operations' of BCM56XX 

switches. 

SYNTAX || 

Note: 

• Stack mode is always in the duplex mode, which is derived from CPCI910 

hardware design. 

• Stacking count is set to '1' because of duplex mode. 

• For more information, see file, stack.c 

Example: 

A2 | B1 | 

OVER: 

By default, switches are configured in cascaded mode. Ports involved in cascading/stacking 

are hard wired on CPCI910. Therefore, the ports shown in default config 

file should not be modified. 

Port number 2 of switch A and port number 1 of switch B are hard wired on board 

for cascading/stacking purposes. 

• TRUNK 

This command allows you to create trunk. The syntax for trunk configuration is as 

follows: 

SYNTAX TID |PORTS | PSC |BCAST_PORT| 



VLAN 

INPUT 

Note: Only the broadcast port will appear in VLAN. 

Example: 

0 | A4,A5 | 1 | A4 | 

4 | B3,B4 | 1 | B3 | 

OVER: 

TID Trunk id to be created. 

PORTS List of trunk members separated by commas. 

PSC Port selection criteria. 

BCAST_POR 

T 

Designated broadcast/DLF port for trunk. 

Note: All the fields are separated by '|' character. 

• VLAN 

This command allows you to create tagged vlans. The syntax for vlan configuration 

is as follows: 

SYNTAX | | | 

INPUT 

Note: Stack ports should not be included in untagged members. 

Example: 

2 | A0,A1,A2,A3,A4,A5,A6,A7 | A0,A1,A3,A4,A5,A6,A7 | 

3 | B0,B1,B2,B3,B4,B5,B6,B7 | B0,B2,B3,B4,B5,B6,B7 | 

OVER: 

VLANID vlan id to be created. 



TAGGED 

VLAN 

PORTS 

UNTAGGED 

VLAN 

PORTS 

PORTCONTROL 

AUTOLEARN 

Comma separated list of vlan members. 

Comma separated list of untagged members of vlan. 

Note: 

• Ports specified in UNTAGGED VLAN PORTS are subset of TAGGED 

VLAN PORTS. 

• The field separation character '|' is very important. If there are no 

untagged members in a vlan, the last '|' char is still required. 

• Port related configuration 

The syntax for vlan configuration is as follows: 

SYNTAX PORTS| SPEEDMODE | or PORTS| ON | 

Note: 

• Either you can force ports to a particular speed and mode or, you can set 

them in auto-negotiate mode. 

• The possible SPEEDMODEs are 10H, 10F, 100H, 100F, 1000H, 1000F 

• Multiple port listing is separated by the ',' seperator. 

Example: 

A3 | 10H | 

A4 | 100F | 

A0,A1,A2,A5,A6,A7,B1,B6,B2,B3,B4,B0,B7,B5| ON | 

OVER: 

This command allows you to control port speed. 

• Port learning 

Port learning allows you to configure MAC address learning behavior on each port. 

The syntax is as follows. 

SYNTAX PORTS| ALFLAG| 

The valid values for ALFLAG are the following: 



5- Learn ARL, do not send to CPU for learning, switch the packet 

2- Do not learn ARL, send to CPU for learning, do not switch the packet 

7- Learn ARL, send to CPU for learning, switch the packet 

4- Do not learn ARL, do not send to CPU for learning, switch the packet 

0- Do not learn ARL, do not send to CPU for learning, do not switch the packet 

Example: 

A0 | 5 | A1 | 5 | A2 | 5 | A3 | 5 | A4 | 5 | A5 | 5 | A6 | 5 | A7 | 

5 | 

B0 | 5 | B1 | 5 | B2 | 5 | B3 | 5 | B4 | 0 | B5 | 5 | B6 | 5 | B7 | 

5 | 

#OVER: 

MAC Numbers in Boot Flash 

There are 21 unique MAC numbers stored in Boot Flash. Devices requiring unique 

MAC numbers can read the MAC numbers by executing an API. The API for reading 

MAC number is available in API call reference section. 

The following tabulates the distribution of MAC numbers among various devices: 

Table 1:Distribution of MAC Numbers Among Devices 

MAC Number Device Using MAC Number 

0 Peth0 of IXP A 

1 Peth1 of IXP A 

2 Peth0 of IXP B 

3 Peth1 of IXP B 

4 BCM packet driver 

Support for IXP1250 Microcode Development IDE 

Intel IXP1250 microcode development IDE requires support from the target board. 

CPCI910 supports IXP1250 microcode development IDE. IDE running on Windows 

NT machine can load microcode on microengines on CPCI910. This is a very 

useful feature during development phase. For details on IXP1250 microcode development 

IDE, you can refer Intel documentation. 

The following steps should be carried out to create a ramdisk for IDE support: 

1. Mount the ramdisk using the following command 



#gunzip ramdisk_img.gz; mount -t ext2 -o loop ramdisk_img ./mnt 

2. Do not run /etc/rc.d/init.d/ueinit on boot 

#mv /etc/rc.d/rc3.d/S52ueinit /etc/rc.d/rc3.d/K52ueinit 

3. Make /etc/rc.d/init.d/rsudebuginit run on boot 

#cd /etc/rc.d/rc3.d ; ln -s ../init.d/rsudebuginit S52rsudebuginit 

4. Unmount the ramdisk 

#umount ./mnt; gzip ramdisk_img 

Use the modified ramdisk for development. 

Note: Only IXP-A microengines can be controlled by IDE. Therefore, init 

script loads sample microcode (/cpci910/bonsai.uof) on IXP-B microengines. 




2 

API Call Reference

API Call Reference List of APIs 

List of APIs 

The Broadcom BCM5680 APIs reside in a kernel space. All API calls of 

Broadcom SDK are exported to the kernel. You can access these functions by 

writing a kernel module. The logical grouping of exported functions are: 

• Virtual Local Area Network 

• Address Resolution Logic 

• Filters 

• Register Access 

• Trunking 

• Stacking 

• PTABLE Management 

• Packet Driver API 

• Port related API 

• L3 features 

• Multicast table management 

• Mirroring 

• CoSQ Management 

• MAC read 

• Watchdog support 

Each of these are detailed in this chapter. 


List of APIs API Call Reference 

Note: 

Virtual Local Area Network 

int bcm_vlan_create (int unit, int vid) 

• Unit= 0 refers to BCM switch connected to IXP-A and unit=1 refers to 

BCM switch connected to IXP-B 

• The term “Input” used in this chapter is a parameter that must be 

passed to the function. 

• The term “Output” used in this chapter is the result of the function. 

• The term “Return” used in this chapter is the value returned by the 

function. 

• Refer to the “Error Codes” page A-3 for details on error codes that 

are returned. 

Please look into file src/tulsi_drivers/bcm_cli_kern/error.h for definitions 

of error codes. 

• Valid port numbers are 0 to 7 for gigabit ports and 27 for CPU port 

The BCM SDK API layer provides the capability to manipulate the Virtual 

Local Area Network (VLAN) configuration of the system. This provides full 

access to the bitmaps associated with each VLAN and ensures consistency 

within the system. 

Basic VLAN configuration allows the creation and destruction of VLANs and 

the addition and removal of ports from a VLAN. The BCM API layer maintains 

consistency between trunking, VLAN configuration and port-based 

VLAN configuration. 

Port based VLAN determines the VLAN tag that is assigned to untagged 

packets arriving on that port. These packets may or may not exit with the tag 

depending on the configuration of that VLAN. 

DESCRIPTION Allocates and configure a VLAN on the Broadcom switching device 

INCLUDE src/tulsi_drivers/bcm_cli_kern/vlan.h 

INPUT 

Unit Unit number (driver internal) 



Vid VLAN ID to create, as described in the IEEE 802.1q Standard 

RETURN VALUE 

BCM_E_VLAN_EXISTS (VLAN ID already in use) 

BCM_E_XXX 

int bcm_vlan_destroy (int unit, int vid) 

BCM_E_NONE (Success) 

DESCRIPTION Deallocates VLAN from the device 


INPUT 

unit Unit number (driver internal) 

RETURN VALUE 

BCM_E_VLAN_ID - (Cannot remove default VLAN.) 


Note: The default VLAN cannot be destroyed. 



int bcm_vlan_destroy_all (int unit) 

DESCRIPTION Deallocates all VLANs from the device 


INPUT 


RETURN VALUE 

BCM_E_XXX 


Note: The default VLAN cannot be destroyed. See vlan_destroy. 



int bcm_vlan_port_add (int unit, int vid, unsigned int pbmb, unsigned int ubmp) 

DESCRIPTION Adds ports to the specified VLAN 


INPUT 


Vid VLAN ID to add port to as a member 

Pbmp Direct bitmap 

Ubmp Bitmap specifying untagged members of VLAN. Outgoing packets to these 

ports will not contain the 802.1q Tag Header 

RETURN VALUE 

BCM_E_VLAN_NOT_FOUND - (VLAN ID does not exist) 

BCM_E_XXX 


Note: The port bitmap specifies ALL ports to be added the VLAN. The 

untagged bitmap specifies the subset of these ports that are untagged. 

int bcm_vlan_port_remove (int unit, int vid, unsigned int pbmp) 

DESCRIPTION Removes the specified ports from the given VLAN 


INPUT 


Vid VLAN ID from which the port(s) will be removed 

Pbmp Bitmap specifying VLAN members 



RETURN VALUE 

BCM_E_VLAN_NOT_FOUND (VLAN ID does not exist) 

BCM_E_XXX 


int bcm_vlan_port_get (int unit, int vid, unsigned int *pbmp, unsigned int *ubmp) 

DESCRIPTION Retrieves the ports assigned to an existing VLAN 


INPUT 


Vid VLAN ID. to lookup 

Pbmp (OUT) member port bitmap (ignored if NULL) 

Ubmp (OUT) untagged port bitmap (ignored if NULL) 

RETURN VALUE 

BCM_E_VLAN_NOT_FOUND - (No such VLAN defined) 


Address Resolution Table Management 

Note: The resulting bitmaps may only show a single port of a trunk 

group. 

The BCM Layer 2 API allows application developers to manage Layer 2 table 

of BCM5680 device. In addition to allowing programming of the Address 

Resolution (ARL) tables, they also provide mechanisms for changing the 

behavior of the ARL controller in general. 



Fundamental to the use of L2 address table entries is an opaque type, which is 

used to communicate the L2 entry to the BCM5680 device. 

struct arl_t { 

unsigned int flags; /* BCM_L2_XXX flags */ 

unsigned char mac[6];/* 802.3 MAC address */ 

unsigned short vid; /* VLAN identifier */ 

int port; /* Zero-based port number */ 

int tgid; /* Trunk group ID */ 

int rtag; /* Trunk port select formula */ 

int cos_dst; /* COS based on dst addr */ 

int cos_src; /* COS based on src addr */ 

} arl_t; 

In other API routines, either a MAC address (unsigned char *) and/or 

VLAN ID (int) are used for manipulation of the address table. 

int bcm_l2_addr_remove_by_port(int unit, unsigned int pbmp, unsigned int flags) 

DESCRIPTION Removes all L2 (MAC) addresses associated with the port 

INCLUDE src/tulsi_drivers/bcm_cli_kern/arl.h 

INPUT 

unit StrataSwitch PCI device unit number (driver internal) 

pbmp Bitmap of ports to affect 

flags BCM_L2_REMOVE_XXX 

RETURN VALUE 


BCM_E_INTERNAL (Chip access Failure) 

Note: Static entries are removed only if BCM_L2_REMOVE_STATIC 

flag is used. 

Note: ARL aging and learning on all ports is disabled during this operation. 

If these were not disabled, the hardware could shift the contents of 



the ARL table during the remove operation, causing some entries that 

should be removed to remain in the table. 

int bcm_l2_addr_remove_by_vlan (int unit, int vid, unsigned int flags) 

DESCRIPTION Removes all L2 (MAC) addresses associated with vid 


INPUT 

unit Device number 

vlan vid to check 


RETURN VALUE 



Note: Static entries are removed only if BCM_L2_REMOVE_ STATIC 

flag is used. 


If these were not disabled, the hardware could shift the contents of 

the ARL table during the remove operation, causing some entries that 

should be removed to remain in the table. 

int bcm_l2_addr_remove_by_trunk(int unit, int tid, unsigned int flags) 

DESCRIPTION Removes all L2 (MAC) addresses associated with tid 




INPUT 

unit StrataSwitch PCI device unit number (driver internal) 

tid tid to check 


RETURN VALUE 


int bcm_l2_addr_add (int unit, arl_t *l2addr) 

BCM_E_INTERNAL(Chip access Failure) 

Note: Static entries are removed only if BCM_L2_REMOVE_STATIC 

flag is used. 


If these were not disabled, the hardware could shift around the contents 

of the ARL table during the remove operation, causing some entries 

that should be removed to remain in the table. 

DESCRIPTION Adds the L2 address entry to the specified device 


INPUT 

Unit Unit number 

arl_t ARL entry structure (look for arl_t structure in the arl.h file) 



RETURN VALUE 

BCM_E_XXX 


BCM L2 Flags: The flags given below are defined in arl.h file. 

BCM_L2_COS_SRC_PRI 

BCM_L2_DISCARD_DST 

BCM_L2_COPY_TO_CPU 

BCM_L2_L3LOOKUP 

BCM_L2_STATIC 

BCM_L2_HIT 

BCM_L2_TRUNK_MEMBER 

BCM_L2_RTAG_MAC_SRC 

Source COS has priority over Destination COS 

Discard on destination 

Send a copy to the CPU 

L3 interface MAC address 

Static entry (non-aged) 

The switch recorded a hit for this entry 

Also a member of trunk group 

If L2_TRUNK_MEMBER bit is set in the flags, the following should be provided 

for the rtag filed of the provided arl_t data 

Trunk selection based on Source MAC address 



BCM_L2_RTAG_MAC_SRCDST 

BCM_L2_RTAG_IP_SRC 

BCM_L2_RTAG_IP_DST 

BCM_L2_RTAG_IP_SRCDST 

Trunk selection based on Source and destination MAC Address 

Trunk selection based on IP (L3) source address 

Trunk selection based on IP (L3) source address 

Trunk selection based on Source and destination IP (L3) address 

int bcm_l2_addr_remove (int unit, unsigned char *mac, int vid) 

DESCRIPTION Removes the MAC address for the specified VLAN from the ARL table 


INPUT 

unit Number 

Mac 802.3 MAC address 

Vid VLAN ID 

RETURN VALUE 

BCM_E_XXX 


int bcm_l2_addr_get (int unit, unsigned char *mac, int vid, arl_t *l2addr) 

DESCRIPTION Given a MAC address and VLAN ID, check if the entry is present in the L2 

table, and if so, return an entry 




INPUT 


Mac MAC address to search 

Vid VLAN ID to search 

l2addr (OUT) Pointer to arl_t structure to receive results 

RETURN VALUE 

Filter Management 

BCM_E_PARAM Illegal parameter (NULL pointer) 

BCM_E_L2_NOT_FOUND Address not found (l2addr not filled in) 

BCM_E_XXX 


On Success, the flags mentioned in page 2-12 may be set for the entry 

The BCM SDK filter layer APIs provide access to the BCM 5680 filtering 

features. Filters can be used to classify packets based on certain protocol 

fields from Layer 2 through Layer 7. Based on these classifications, you can 

perform various actions such as: 

• Discarding the packet 

• Sending the packet to CPU 

• Sending the packet to mirrored port 

• Sending the packet to COS queue 

• Changing the 802.1p.QoS 

Filters are composed of two parts: 

• Field mask 

• Rules 

Field Mask specifies packet data fields being searched. 

Rules specify the action to be taken should a match occur. 



int bcm_filter_create(int unit, struct filter **bf_return) 

DESCRIPTION Creates new filter 

INCLUDE src/tulsi_drivers/bcm_cli_kern/filter.h 

INPUT 


bf_return Kernel pointer to filter template. Memory for this template is allocated by 

API. This memory which, when released by API while destroying. 

bf_return should be used as a handle for further filter settings. The 

struct filter is defined in filter.h 

RETURN VALUE 

BCM_E_XXX 


int bcm_filter_remove(int unit, struct filter *bf) 

DESCRIPTION This API removes the filter entry from hardware, but is still maintains the filter 

settings in software template 


INPUT 

unit Device number. 

bf Pointer to filter template. 



RETURN VALUE 

BCM_E_XXX 


int bcm_filter_destroy(int unit, struct filter *bf) 

DESCRIPTION This API frees memory corresponding to software template 


INPUT 

Unit Device number. 

bf Pointer to filter template 

RETURN VALUE 

BCM_E_XXX 


int bcm_filter_qualify_priority(int unit, struct filter *bf, int prio) 

DESCRIPTION Sets priority of this filter relative to other filters that match simultaneously 


INPUT 

Unit Device number. 


prio Relative priority from 0 (min) to 255 (max) 



RETURN VALUE 

BCM_E_XXX 


int bcm_filter_qualify_ingress(int unit, struct filter *bf, unsigned int pbmp) 

DESCRIPTION Sets ingress port(s) that the packet must match to trigger filter 


INPUT 



pbmp Bitmap of ingress ports eg. 0x02 for Port number 1 

RETURN VALUE 

BCM_E_XXX 


int bcm_filter_qualify_egress(int unit, struct filter *bf, unsigned int pbmp) 

DESCRIPTION Sets egress port(s) that the packet must match to trigger filter 


INPUT 



pbmp Bitmap of egress ports eg. 0x02 for Port number 1 



RETURN VALUE 

BCM_E_XXX 


int bcm_filter_qualify_data(int unit, struct filter *bf, int offset, int len, unsigned char *val , unsigned 

char *mask ) 

DESCRIPTION Adds data field that the packet must match to trigger filter 


INPUT 


bf Pointer to filter template. 

offset Offset in packet at which value to be seen 

len Length of pattern eg. 1 

Value Value to be matched eg. 0xFF 

mask Mask to be applied on packet data eg. 0xFF 

RETURN VALUE 

BCM_E_XXX 


int bcm_filter_action_match(int unit, struct filter *bf , filter_action_t action, unsigned int param ) 

DESCRIPTION Sets the action to be taken when filter triggers 




INPUT 



action Action to be taken 

(Look for possible actions in enum filter_action_t in filter.h) 

param Parameter required by some actions (use 0 if not required) 

RETURN VALUE 

BCM_E_XXX 


int bcm_filter_install(int unit, struct filter *bf ) 

DESCRIPTION Gets the created filter in action 


INPUT 



RETURN VALUE 

BCM_E_XXX 


int bcm_filter_reinstall(int unit, struct filter *bf ) 

DESCRIPTION This API re-installs the filter if you want to dynamically change the action to 

be taken 




INPUT 



RETURN VALUE 

Steps To Create a Filter 

BCM_E_XXX 


Note: 

• This API can be used if you want to dynamically change the action to 

be taken while the filter is in action. 

• If you have already removed the filter using the API 

bcm_filter_remove(), use the API bcm_filter_install() 

for reconfiguring the filter. 

Filter initialization happens as part of BCM switch init. The steps to create a 

filter as follows: 

1. Filter create 

This will give you a handle for the created filter. You have to provide this handle 

for further configuration. 

2. Qualify ingress or qualify egress 

Depending upon where you want to apply filter rule, you specify the bitmap. 

It can be either ingress, egress, or both. 

3. Filter qualify data 

This is to specify the data pattern you are expecting in the packet. 

Example: 

Data pattern - 0x8100 (hex value) 

Offset - 12 ( zero reference value in decimal ) 



4. Filter action match 

This is to specify the action to take when you get a filter match. 

For a sample case, if the action is set to 6, which is the sent packet to a specified 

port, the port number can be specified as 'param'. 

Details of other possible actions can be found in the Programmer's Reference 

Guide. 

The filter action match also requires the parameter and meter ids. For certain 

actions, the parameters have to be provided. If the parameter or meter ids are 

not relevant, they may be set to zero. The possible action description and corresponding 

number is given in the table below: 

Table 2: Filter Action Match-Number and Action Description 

Action Value 

Discard packet (still copy to cpu/mirr) 0 

Do switch(Overrides a drop decision that is matched by a different rule 1 

Send a Copy of packet to CPU port 2 

Send a Copy of packet to Mirror-to port 3 

Set 802.1p priority for CoSQ assignment without modifying packet 5 

Redirect normally switched unicast packet to specific port 6 

Set IPv4 TOS value in packet PARAMETER: TOS 10 

5. Qualify filter priority 

This sets the priority among the filters. If two different filter rules match 

simultaneously on a same packet, the filter with the higher priority is applied. 

The priority range is 0 - 255, with 255 being the highest range. 

6. Install filter 

This puts the filter into action 

7. Reinstall filter 

Use this API to re-install the filter if you want to dynamically change the 

action to be taken. 



Register Access 

8. Remove filter 

This is used to remove the filter from action. Removing the filter still preserves 

the filter settings. To reactivate the filter, after removing it, use the API 

bcm_install_filter(). 

9. Destroy filter 

Use this procedure to destroy filter settings completely. 

Under this section of BCM APIs three types of register access is made available 

to application writers: 

• PCI config space of BCM5680 devices. 

• PCI memory mapped registers. 

• BCM5680 internal registers through S-channel message mechanism. 

Each of these have read/write calls. 

Note: Ensure that the Application Writer knows the details of each register 

being accessed. 

Caution Improper values written to registers can threaten switch functioning. 



MIIM APIs 

int cmic_read_miim(int unit, unsigned char phy_id, unsigned char phy_reg_addr, unsigned short 

*phy_rd_data) 

DESCRIPTION Reads a value from a PHY register 

INCLUDE src/tulsi_drivers/bcm_cli_kern/miim.h 

INPUT 


phy_id PHY ID to read (MIIM Address) 

phy_reg_addr PHY register to read 

phy_rd_data (OUT) data in the register 

RETURN VALUE 

Returns SOC_E_NONE, if Successful, else negative value 

int cmic_write_miim(int unit, unsigned char phy_id, unsigned char phy_reg_addr, unsgned short 

phy_wr_data) 

DESCRIPTION Writes a value to a MIIM register 

INCLUDE src/tulsi_drivers/bcm_cli_kern/miim.h 

INPUT 


phy_id Phy ID to write (MIIM address) 

phy_reg_addr PHY register to write 

phy_wr_date Data to write 



RETURN VALUE 

Interrupt Control APIs 

unsigned int cmic_irq_enable(int unit, unsigned int mask) 

Returns SOC_E_NONE, if Successful, else returns a negative value 

DESCRIPTION Enables a set of CMIC Interrupts 

INCLUDE src/tulsi_drivers/bcm_cli_kern/interrupt.h 

INPUT 


mask The bit mask of interrupts to be enabled. 

RETURN VALUE 

The previous bitmask of enabled interrupts. 

unsigned int cmic_irq_disable(int unit, unsigned int mask) 

DESCRIPTION Disables a set of CMIC Interrupts 

INCLUDE src/tulsi_drivers/bcm_cli_kern/interrupt.h 

INPUT 


mask The bit mask of interrupts to be disabled 



RETURN VALUE 

PCI Config Space 

The previous bitmask of enabled interrupts 

int PCI_config_read( int unit, uint32 offset, uint32 *data) 

Following APIs allows you to read/write config space memory corresponding 

to BCM5680 devices. These APIs are wrappers around PCI config space 

kernel calls. 

DESCRIPTION Reads PCI config space of BCM5680 device 

INCLUDE src/tulsi_drivers/bcm_cli_kern/pci.h 

INPUT 

unit Device number between 0 to 1 

offset Valid offset within config space (0 - 255) 

data Value read 

RETURN VALUE 

0 (Success) 

-ve (Failure) 

int PCI_config_write( int unit, uint32 offset, uint32 data) 

DESCRIPTION Writing PCI config space of BCM5680 device 


INPUT 

unit Device number between 0 to 1 

offset Valid offset within config space (0 - 255) 



data Value to be written 

RETURN VALUE 

0 (Success) 

-ve (Failure) 

PCI Memory Mapped Registers 

unsigned int cmic_pci_getreg(int unit, unsigned int addr) 

The following APIs allow you to read/write BCM5680 PCI memory mapped 

registers. For details of list of PCI memory mapped registers see BCM5680 

product family Register Reference. 

DESCRIPTION Reads CMIC PCI register 


INPUT 


addr Register address 

RETURN VALUE 

This API returns the data stored in the register. 

int cmic_pci_setreg(int unit, unsigned int addr, unsigned int data) 

DESCRIPTION Sets CMIC PCI register 


INPUT 






RETURN VALUE 

Indirect Mapped Registers 

0 (Success) 

-ve (Failure) 

The following APIs allow you to read/write BCM5680 indirect mapped registers. 

For a detailed list of indirect mapped registers see BCM5680 product 

family Register Reference. 

S-channel messaging mechanism is used to read/write this category of registers. 

Indirect mapped registers are a set of registers for each block. While calculating 

offset for each block zero based block number is used. 

For example 

Register GEGR_ENABLE 

Offset 0x00m80001 

For block 0 - 0x00080001 

For block 1 - 0x00180001 

int cmic_read_reg(int unit, unsigned int addr, unsigned int *data) 

DESCRIPTION Reads an internal SOC register through S-Channel messaging buffer 


INPUT 



data (OUT) data stored in the register 



RETURN VALUE 

SOC_E_NONE (Success) 

-ve (Failure) 

int cmic_write_reg(int unit, unsigned int addr, unsigned int data) 

DESCRIPTION Writes an internal SOC register through S-Channel messaging buffer 


INPUT 




RETURN VALUE 

Trunking (Link Aggregation) 

SOC_E_NONE (Success) 

-ve (Failure) 

Trunking (also know as Port Bundling and Link Aggregation is a method by 

which up to eight Ethernet ports can be bundled together to form a trunk. The 

trunk is like one logical link, and is useful when one requires high bandwidth 

and/or redundancy between switches. All ports in a trunk must be configured 

with the same speed and Full Duplex. 

Trunking can provide a number of valuable features such as: 

• Incremental bandwidth based on demand. 

• Link redundancy, in the case of a trunk port with the Failure, is removed 

from the trunk group. 

• High bandwidth load balancing. 



int bcm_trunk_use_tid(int unit, int tid, int psc) 

Note: Please refer header files in sample code for argument types, which 

are passed/received as structure. 

DESCRIPTION Creates a trunk group with specified trunk ID 

INCLUDE src/tulsi_drivers/bcm_cli_kern/trunk.h 

INPUT 


tid Trunk ID 

psc Identify the trunk selection criteria (see note on RTAG in Trunk Usage 

page 2-34) 

RETURN VALUE 


BCM_E_XXX 

int bcm_trunk_create(int unit, int psc, int *tid) 

DESCRIPTION Creates trunk group 

Note: The function above does not provide any ASIC tables update. 


INPUT 


psc Port selection criteria (see note on RTAG in Trunk Usage page 2-34) 

tid Created trunk id (output parameter) 



RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_psc_get(int unit, int tid, int *psc ) 

-1 - (Out of range parameter values) 

DESCRIPTION Gets port selection criteria for a trunk group 


INPUT 


tid Trunk ID. 

psc Port selection criteria (output parameter) 

RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_info_get(int unit, struct t_info *ta_info) 

DESCRIPTION Gets trunking information for a specified unit 


INPUT 


ta_info Trunk information (output parameter) 

(Look for struct t_info in trunk.h) 



RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_broadcast_port_get(int unit, int tid, int *port ) 

DESCRIPTION Gest broadcast port for a specified trunk 


INPUT 


tid Trunk ID. 

port Broadcast port (output parameter) 

RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_set( int unit, int tid, struct t_add_info*add_info) 

DESCRIPTION Adds ports to a trunk group 


INPUT 


tid Trunk ID. 

add_info Trunk information to be set 

(Look for struct t_add_info in trunk.h) 



RETURN VALUE 

BCM_E_XXX 

int bcm_trunk_destroy(int unit, int tid ) 


DESCRIPTION Destroys specified trunk 


INPUT 


tid Trunk ID. to be destroyed 

RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_mcast_join(int unit, int tid, int vid , unsigned char *mac ) 

DESCRIPTION Adds the trunk group to the existing MAC multicast entry 


INPUT 


tid Trunk ID. 

vid VLAN ID 

mac Multicast MAC address 



RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_bitmap_expand(int unit , unsigned int *pbmp_ptr) 

DESCRIPTION Given a port bitmap, if any of the ports are in a trunk, adds ALL of the ports in 

that trunk to the bitmap 


INPUT 


pbmp_ptr Bitmap to be forced in trunk (input/output para) 

RETURN VALUE 

BCM_E_XXX 


int bcm_trunk_get( int unit, int tid,int flag, void *t_data ) 

DESCRIPTION Returns a port information of given trunk ID 


INPUT 


tid Trunk ID. 

flag Indicates what format of trunk information will be returned 

pbmp Place to store bitmap of returned ports. (Output parameter) 



Trunk Usage 

RETURN VALUE 

BCM_E_XXX 


The steps to be followed for trunk usage are given below: 

1. Trunk create 

This procedure creates a trunk and returns the trunk ID. This procedure 

prompts for the RTAG value. 

The various values for the RTAG field are described below: 

2. Add ports 

This procedure adds trunk members to the specified trunk ID. 

The RTAG value decides port selection criteria among the member ports. 

Table 3: 

RTAG Value Port Selection 

1 Selection based on source MAC address destination 

2 Selection based on source MAC address 

3 Selection based on source and destination MAC 

addresses 

4 Selection based on source IP address 

5 Selection based on destination IP address 

6 Selection based on source and destination IP addresses 

3. Trunk destroy 

This procedure destroys the trunk. 

4. Get port info of a trunk ID 

If provided with unit number and trunk id, this procedure provides member 

ports with the trunk. 



Stacking 

5. Get trunk selection criteria 

This procedure obtains the port selection criteria for a given trunk ID. 

6. Get dedicated broadcast port for trunk group 

This procedure gets the broadcast port for a given trunk ID. 

7. Add trunk to multicast entry 

This procedure adds the trunk to a multicast table. 

8. Trunk bit map update 

int bcm_stk_init(int unit, unsigned int sp, int mode) 

This procedure, when provided with a port bitmap, and if any of the ports are 

in a trunk, adds all the ports in that trunk. 

After the driver performs BCM5680 initialization, the switch remains in cascaded 

mode. 

The APIs used for stacking mode of operation between multiple BCM5680 

devices, are given below: 

DESCRIPTION Initializes the stack module 

INCLUDE src/tulsi_drivers/bcm_cli_kern/stack.h 

INPUT 


sp Bitmap of the ports involved in stacking mode eg. 0x02 

mode The mode of stacking: 

0 - Duplex 

1 - Simplex 



RETURN VALUE 

BCM_E_XXX 


int bcm_stk_port_get(int unit, unsigned int *sp) 

DESCRIPTION Gets the bitmap of ports that are involved in stacking 


INPUT 


sp Bitmap of stack ports (output parameters) 

RETURN VALUE 

BCM_E_XXX 


int bcm_stk_port_is_stack(int unit, int port) 

DESCRIPTION Checks if the given port is a stacking port 


INPUT 


port Port number 



RETURN VALUE 

PTABLE Management 

1 (Port is a stacking port) 

0 (Port is not a stacking port) 

-ve (Failure) 

These APIs help in modifying/view PTABLE entries. 

int bcm_port_vlan_set(int unit, unsigned int port, int vid) 

DESCRIPTION Sets PTABLE entries for given ports with sepcified vid 

INCLUDE src/tulsi_drivers/bcm_cli_kern/pvlan.h 

INPUT 


port Port bitmap of VLAN members eg. 0xFF 

vid vid to be forced for above ports 

RETURN VALUE 

BCM_E_XXX 


Note: Specified vid should exist in VTABLE and all specified ports 

should be members of that VLAN. 

int bcm_port_vlan_get(int unit, int port, struct vlan_data_t *vdata) 

DESCRIPTION Gets PTABLE entry for a given port 

INCLUDE src/tulsi_drivers/bcm_cli_kern/pvlan.h 



INPUT 



vdata VLAN data (Output parameter) 

(Look for struct vlan_data_t in vlan.h) 

RETURN VALUE 

Packet Driver APIs 

BCM_E_XXX 


The set of functions available in this API enables you to send packets to the 

network attached to the Gigabit Switches on CPCI-910. 

Note: The packets should be a valid Ethernet packet with 4 Bytes of 

Frame Check Sequence (FCS) at the end of the packet. The length 

includes FCS bytes. However, the FCS could also be updated by the 

Gigabit Switch depending upon the flags setting. 

int bcm_packet_send_sync(int unit, void *packet, int length, uint32 flags) 

DESCRIPTION Sends a packet synchronously based on the destination MAC address 

INCLUDE src/tulsi_drivers/bcm_cli_kern/packet.h 

INPUT 

unit Device number (0 to 1) 

packet Pointer to valid Ethernet packet 

length Packet length 

flags Flags indicating various actions; currently supported are: 

• BCM_PACKET_CRC_APPEND - append CRC 



RETURN VALUE 

• BCM_PACKET_CRC_REGEN - regenerate CRC 

• BCM_PACKET_CRC_VALID - valid CRC already. 

If the packet has valid CRC, but a tag is inserted, then this routine will override 

a VALID flag to BCM_PACKET_CRC_REGEN. 

BCM_E_XXX 


int bcm_packet_send_async(int unit, rl_packet_callback_t f, void *cookie, void *packet, int length, 

uint32 flags) 

DESCRIPTION Sends a packet asynchronously, and call back to the specified function 

INCLUDE src/tulsi_drivers/bcm_cli_kern/packet.h 

INPUT 

unit Device number (0 to 1) 

f Callback function (void f(int unit, void *packet, void *cookie)) 

cookie Context pointer for callback 

packet Pointer to valid Ethernet packet 

length Packet length 

flags Flags indicating various actions, currently supported are: 

• BCM_PACKET_CRC_APPEND - append CRC 

• BCM_PACKET_CRC_REGEN - regenerate CRC 

• BCM_PACKET_CRC_VALID -valid CRC already. 

If the packet has valid CRC, but a tag is inserted, then this routine will override 

a VALID flag to BCM_PACKET_CRC_REGEN. 



RETURN VALUE 

Port-Related APIs 

BCM_E_XXX 


These APIs allow to control the following features of the port. 

• Controlling the link scanning mode for the port. 

• Get/set the speed of the port. 

• Get/set the duplex mode of the port. 

• Get/set the learning behavior of the port. 

• Get/set the auto-negotiation behavior of the port. 

• Get/set the pause control behavior of the port. 

• Get/set the loopback on the port. 

• Shutdown the port 

• Bringup the port 

• Get/set the STP behavior of the port 

• Get the type of daughter card (copper/fibre) 

Listed below are the port-related APIs supported. 

int bcm_port_linkscan_get(int unit, int port, int *linkscan) 

Note: Auto-Negotiation is MANDATORY for gigabit Ethernet. It is 

ILLEGAL to force a device into 1000BASE-T mode. The BCM Demo 

Software provides a mechanism for diagnostic modes that allow a device 

to be forced into 1000Base-T mode. However, these modes should not be 

used for establishing a normal link. 

DESCRIPTION Returns the linkscan mode for the port 

INCLUDE src/tulsi_drivers/bcm_cli_kern/port.h 

INPUT 





linkscan Pointer where return value will be stored 

RETURN VALUE 

BCM_E_XXX 


Returns pointer if return value from function is BCM_E_NONE, the return 

values would be as follows: 

LINKSCAN_MODE_NONE (Linkscan disabled) 

LINKSCAN_MODE_SW - (Software Linkscan) 

LINKSCAN_MODE_HW - (Hardware Linkscan) 

int bcm_port_linkscan_set(int unit, int port, int linkscan) 

DESCRIPTION Sets the linkscan mode for port 


INPUT 

unit Unit number 


linkscan The mode to be set which can be any of the following: 

LINKSCAN_MODE_NONE (Linkscan disabled) 

LINKSCAN_MODE_SW (Software Linkscan) 

LINKSCAN_MODE_HW (Hardware Linkscan) 



RETURN VALUE 

BCM_E_XXX 


int bcm_port_link_status_get(int unit, int port, int *up) 

DESCRIPTION Gets the link status on the port 


INPUT 



up The return pointer where status will be stored 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_autoneg_get(int unit, int port, int *autoneg) 

Returns pointer if return value from function is BCM_E_NONE, if value of 

up is 1, the link is up, else the link is down. 

DESCRIPTION Gets the auto negotiation status for the port 


INPUT 



autoneg The return pointer where status will be stored 



RETURN VALUE 

BCM_E_XXX 


Returns pointer if return value from function is BCM_E_NONE. If the 

autoneg value is 1, the auto negotiation is enabled, else auto negotiation 

disabled. 

Note: Refer note on page 2-40 on auto-negotiation. 

int bcm_port_autoneg_set(int unit, int port, int autoneg) 

DESCRIPTION Sets the auto negotiation status for the port 


INPUT 



autoneg The value to be set, which can be 1 - enable, 0 - disable 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_speed_get(int unit, int port, int *speed) 

DESCRIPTION Gets the speed for the port 


INPUT 





autoneg The return pointer where speed will be stored 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_speed_set(int unit, int port, int speed) 

Returns pointer if return value from function is BCM_E_NONE. The values 

of speed will be either 10, 100 or 1000 mbps. 

DESCRIPTION Set the speed for the port 


INPUT 



speed The speed to be set , which can be 10, 100, or 1000 mbps 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_duplex_get(int unit, int port, int *duplex) 


DESCRIPTION Gets the mode for the port 




INPUT 



duplex The return pointer where mode will be stored 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_duplex_set(int unit, int port, int duplex) 


of duplex will be either PORT_DUPLEX_HALF or 

PORT_DUPLEX_FULL. 

DESCRIPTION Sets the mode for the port 


INPUT 



mode The mode to be set can be PORT_DUPLEX_HALF - 0 or 

PORT_DUPLEX_FULL - 1. 

RETURN VALUE 

BCM_E_XXX 





int bcm_port_pause_get( int unit, int port, int *pause_tx, int *pause_rx) 

DESCRIPTION Gets the pause mode for the port 


INPUT 



pause_tx The return pointer 

pause_rx The return pointer 

RETURN VALUE 

BCM_E_XXX 



of pause_tx and pause_rx can be 0 (disable) or 1 (enable). 

int bcm_port_pause_set(int unit, int port, int pause_tx, int pause_rx) 

DESCRIPTION Sets the mode for the port 


INPUT 



pause_tx enable - 1 

disable - 0 

pause_rx enable - 1 

disable - 0 



RETURN VALUE 

BCM_E_XXX 


int bcm_port_pause_addr_get(int unit, int port, unsigned char* mac_addr) 

DESCRIPTION Gets the pause address for the port 


INPUT 



mac_addr Return pointer for pause frame mac address 

RETURN VALUE 

BCM_E_XXX 



of mac_addr will contain the pause frame mac address. 

int bcm_port_pause_addr_set( int unit, int port, unsigned char * mac_addr) 

DESCRIPTION Sets the pause address for the port 


INPUT 



mac_addr Pause frame mac address 



RETURN VALUE 

BCM_E_XXX 


int bcm_port_loopback_get( int unit, int port, int *loopback) 

DESCRIPTION Gets the loopback mode for the port 


INPUT 



loopback The return pointer where loopback mode is stored. 

RETURN VALUE 

BCM_E_XXX 



of loopback mode can be the following: 

PORT_LOOPBACK_NONE - 0 

PORT_LOOPBACK_MAC - 1 

PORT_LOOPBACK_PHY - 3 

int bcm_port_loopback_set( int unit, int port, int loopback) 

DESCRIPTION Sets the loopback mode for the port 




INPUT 



loopback The loopback mode for the port, which can be, 

PORT_LOOPBACK_NONE - 0 (loopback disabled). 

PORT_LOOPBACK_MAC - 1 (loopback at mac level). 

PORT_LOOPBACK_PHY - 3 (loopback at phy chip level). 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_stp_get( int unit, int port, int *state) 

Note: Please disable the ARL learning through bcm_port_learn_set() 

API for the port when you set the PORT_LOOPBACK_MAC on that 

port. 

DESCRIPTION Gets the stp state for the port 


INPUT 



state The stp state for the port 



RETURN VALUE 

BCM_E_XXX 



of stp state can be: 

STG_STP_LISTEN - 1 

STG_STP_BLOCK - 2 

STG_STP_LEARN - 3 

STG_STP_FORWARD - 4 

int bcm_port_stp_set( int unit, int port, int state) 

DESCRIPTION Sets the stp state for the port 


INPUT 



state The stp state for the port which can be, 

STG_STP_LISTEN - 1 (Accept BPDUs, no learning) 

STG_STP_BLOCK - 2 (Accept only BPDUs, no learning) 

STG_STP_LEARN - 3 (Packets are learnt, no forwarding) 

STG_STP_FORWARD - 4 (Learning as well as forwarding) 



RETURN VALUE 

BCM_E_XXX 


int bcm_port_learn_get( int unit, int port,unsigned int *flags) 

DESCRIPTION Get the learning flags for the port 


INPUT 



flags The return pointer where flags will be set 

RETURN VALUE 

BCM_E_XXX 



of learn flags can be: 

PORT_LEARN_ARL - 0x01 (Learn SLF address) 

PORT_LEARN_CPU - 0x02 (Copy SLF packet to CPU) 

PORT_LEARN_FWD - 0x04 (Forward SLF packet) 

int bcm_port_learn_set( int unit, int port, unsigned int flags) 

DESCRIPTION Sets the learning flags for the port 




INPUT 



flags The learning state for the port, which can be, 




RETURN VALUE 

BCM_E_XXX 


int bcm_port_learn_modify( int unit, int port, unsigned int add_flags, unsigned int del_flags) 

DESCRIPTION Sets the learning flags for the port 


INPUT 



add_flags The learning flags to be added, which can be, 




del_flags The learning flags to be deleted, which can be, 






RETURN VALUE 

BCM_E_XXX 


int bcm_port_shutdown( int unit, unsigned int ports) 

DESCRIPTION Shutsdown the ports 


INPUT 


ports Bitmap of ports eg. 0xFF 

flags The return pointer where flags will be set 

RETURN VALUE 

BCM_E_XXX 


int bcm_port_bringup( int unit, unsigned int ports) 

DESCRIPTION Brings up the ports 


INPUT 


ports Bitmap of ports i.e 0xff 



RETURN VALUE 

BCM_E_XXX 


enum cardtype bcm_check_card_type(int unit); 

DESCRIPTION Checks the type of daughter card or RTB 


INPUT 


RETURN VALUE 

Port Configurations 

The API returns FIBER or COPPER depending on the card 

The tables below detail the port numbers used in the configuration file: 

Table 4: Switch A Settings 

Port Number Description 

A0 PSB B 

A1 PSB A 

A2 Connected to switch B 

A3-A6 Daughter card ports 

A7 MAC connected to switch A 

Table 5: Switch B Settings 


B0 RTB 

B1 Connected to switch A 

B2 RTB 



Table 5: Switch B Settings 


B3 RTB 

B4 MGT PHY 

B5 RTB 

B6 MGT PHY 

B7 MAC connected to switch B 

The port settings for a unit 0 bitmap would be as follows: 

7 

MAC port 

For example, DCARD port 3 bitmap is - 0x08. 

MAC port bitmap is- 0x80. 

PSBA port bitmap is - 0x02. 

The port settings for a unit 1 bitmap would be as follows: 

7 

MAC port 

6, 5, 4, 3 

DCARD 

1 

Stacking 

2 

Stacking 

1 

PSB A 

0 

PSB B 

The Copper IO-910 and Fiber Optic IO-910 daughter card port configurations 

are diagrammatically represented in the following figures. 

CPCI-910 2 - 55 

6, 4 

PMC 

5,3,2,0 

RTB


Port Number 3 

Port Number 5 

Port Number 6 

Port Number 4 

Figure 3:Copper Daughter Card Port Configuration 

Copper 

Daughter 

Card 

ETH1 

ETH2 

ETH3 

ETH4 



L3 Support APIs 

Port Number- 5 




Figure 4:Fiber Optic Daughter Card Port Configuration 

Fiber Optic 

Daughter 

Card 

ETH1 

ETH2 

ETH3 

ETH4 

The CPCI910 can also be configured to do L3 forwarding in hardware. 

Unlike L2, CPU's role is even more important in L3 forwarding. The CPU's 

help will be required to handle the following: 

• Running ARP protocol to resolve the IP address and to generate and maintain 

ARP table. 

• Running RIP, OSPF, NLSP or other protocols to generate and maintain the 

Routing tables. 

• Setting up the L3INTF, L3 and DEF_IP Table which will be used by BCM 

Switch for L3 forwarding. 



L3 Configuration 

L3 Interface Table Related APIs 

The switch is able to do L3 forwarding at line rate when all the L3 tables on 

the switch are properly populated.The BCM switch has 3 tables for supporting 

L3 functionality, the description of which is given below. 

• L3INTF Table: This table is used for creating, updating and destroying the 

L3 interface. 

• L3 Table: This is the table, in which the search is performed when L3 

switching has to be done based on destination IP Address. 

• L3 DEF_IP Table: If the search in L3 Table results in a Failure, this table 

is used for searching the default entry. 

Note: The following description applies to condition that, CPU is not 

running the ARP protocol for the switch and also there is no dynamic updation 

of L3 tables on the switch by CPU. 

• The L3 interface is created using the 'create a L3 interface' API under "L3 

Interface test" in bcm_appln utility, which will add the interface's, mac 

address and vlan id , to L3INTF table. This also adds the corresponding 

entry in the L2 table with L3 bit of that entry set. So the BCM switch 

knows that entry belongs to L3 Interface and for this L3 switching needs 

to be done. 

• Set the entry in the L3 table for the destination IP address by filling the 

next hop mac address, interface and outgoing port for the packet.Use 

"Add entry to L3 table" under "L3 Table test" in bcm_appln utility for this. 

• Set the entry in the L3 DEF_IP table for packets which don't find a match 

in the L3 table by filling the. Use "Add entry to default IP table" under 

"L3 defip table test" in bcm_appln utility. 

Listed below are the L3 support APIs 

int bcm_l3_interface_create(int unit, unsigned char* mac_addr, int vid, int add_to_arl) 

DESCRIPTION Creates an entry in l3 interface table 

INCLUDE src/tulsi_drivers/bcm_cli_kern/l3.h 



INPUT 


mac_addr 802.3 mac address 

vid Vlan id 

add_to_arl If 1, the entry will be added to ARL table with L3 and static bit set 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_interface_update(int unit, int interface, unsigned char *mac_addr, int vid) 

DESCRIPTION Updates an entry in the L3 interface table 


INPUT 


interface Interface id 

mac_addr 802.3 mac address 

vid Vlan id 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_interface_destroy(int unit, int interface) 

DESCRIPTION Destroys an entry in l3 interface table. 




INPUT 



RETURN VALUE 

BCM_E_XXX 


extern int bcm_l3_status(int unit, int *free_l3intf, int *free_l3, int *free_defip) 

DESCRIPTION Returns the number of free entries in different L3 related table 


INPUT 

L3 Table APIs 


free_l3intf Number of free entries in L3 interface table. 

free_l3 Number of free entries in L3 table. 

free_defip Number of free entries in defip table. 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_ip_add(int unit, int port, unsigned int ip_addr, unsigned char *mac_addr, int interface, int 

hit_set) 

DESCRIPTION Creates an entry in l3 interface table 




INPUT 


port Outgoing port number 

ip_addr IP Address 

mac_addr Next hop 802.3 mac address 


hit_set If 1, it will set the hit bit in L3 table. 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_ip_delete(int unit, unsigned int ip_addr) 

DESCRIPTION Deletes an entry in l3 interface table 


INPUT 



RETURN VALUE 

BCM_E_XXX 


int bcm_l3_ip_delete_by_prefix(int unit, unsigned int ip_addr, unsigned int mask) 

DESCRIPTION Deletes an entry in l3 interface table based on prefix 




INPUT 



mask Netmask to be applied 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_ip_delete_by_index(int unit, int index) 

DESCRIPTION Deletes an entry in l3 interface table by index 


INPUT 


index Index number in the table 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_ip_delete_by_interface(int unit, int interface) 

DESCRIPTION Delete an entry in l3 interface table by interface ID 


INPUT 






RETURN VALUE 

int bcm_l3_ip_delete_all(int unit) 

BCM_E_XXX 


DESCRIPTION Deletes all entries in l3 interface table 


INPUT 


RETURN VALUE 

BCM_E_XXX 


int bcm_l3_ip_find(int unit, unsigned int ip_addr, int *interface, int *port, int *hit, unsigned char 

*mac_addr) 

DESCRIPTION Finds an entry in l3 interface table 


INPUT 


port Pointer to outgoing port number 



interface Pointer to interface id 



hit Check if the hit bit is set. 

RETURN VALUE 

L3 DEFIP Table APIs 

BCM_E_XXX 


int bcm_l3_defip_add(int unit, int port, unsigned int ip_addr, unsigned int mask, unsigned char 

*mac_addr, int interface, unsigned int flags) 

DESCRIPTION Creates an entry in L3 DEFIP table 


INPUT 





interface Interface ID 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_defip_delete(int unit, unsigned int ip_addr,unsigned int mask) 

DESCRIPTION Deletes an entry in L3 DEFIP table based on prefix 




INPUT 




RETURN VALUE 

BCM_E_XXX 


int bcm_l3_defip_delete_by_interface(int unit, int intf) 

DESCRIPTION Deletes an entry in l3 DEFIP table based on interface 


INPUT 


intf Interface id 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_defip_update(int unit, unsigned int ip_addr, unsigned int mask, int interface, int port, 

unsigned char *mac_addr, int cpu) 

DESCRIPTION Updates an entry in L3 DEFIP table 


INPUT 





mask Netmask 




cpu cpu bit 

RETURN VALUE 

BCM_E_XXX 


int bcm_l3_defip_get(int unit, unsigned int ip_addr,unsigned int mask, int *interface,int *port, 

unsigned char *mac_addr, int *cpu) 

DESCRIPTION Gets an entry from L3 DEFIP table 


INPUT 



mask Netmask 




cpu cpu bit 



RETURN VALUE 

BCM_E_XXX 


int bcm_l3_defip_find_index(int unit, int index, unsigned int *ip_addr,int *masklen, int *interface, int 

*port, unsigned char *mac_addr,int *cpu) 

DESCRIPTION Finds an entry in L3 DEFIP table 


INPUT 



masklen Length of mask 




cpu Pointer to cpu bit 

RETURN VALUE 

BCM_E_XXX 




Multicast Table Management 

int bcm_mcast_addr_add(int unit, mcast_addr_t *mcaddr) 

The BCM Switch supports L2 Multicasting. All the packets with a multicast 

group address will be sent to only members of that group. A multicast group 

can be created or destroyed by using the API provided. A port can join or 

leave a multicast group at any time. The PFM (Port filtering mode) of the 

ingress port should be set to mode B. Please refer to Broadcom5680 product 

family register reference. 

The supported APIs and data structure for multicast table management is provided 

in the following sections. 

typedef struct mcast_addr_s { 

unsigned charmac[6];/* 802.3 MAC address */ 

unsigned shortvid;/* VLAN identifier */ 

unsigned intcos_dst;/* COS based on dst addr */ 

unsigned intport_bitmap;/* Port bitmap */ 

unsigned intuntagged_port_bitmap;/* Untag port bitmap */ 

} mcast_addr_t; 

DESCRIPTION Adds an entry in the multicast table 

INCLUDE src/tulsi_drivers/bcm_cli_kern/multicast.h 

INPUT 


mcaddr Pointer to fully filled-in mcast_addr_t 

RETURN VALUE 


BCM_E_INTERNAL (if table write failed) 

int bcm_mcast_addr_remove(int unit, unsigned char *mac, int vid) 

DESCRIPTION Deletes an entry from the multicast table 




INPUT 


mac mac address 

vid vlan id 

RETURN VALUE 


BCM_E_XXXX 

int bcm_mcast_port_get(int unit, unsigned char *mac, int vid, mcast_addr_t *mcaddr) 

DESCRIPTION Gets membership and untagged port bit maps for a MC group 


INPUT 


mac mac address used for lookup 

vid vlan id used for lookup 

mcaddr Pointer to mcast_addr_t that is fully filled in 

RETURN VALUE 


BCM_E_INTERNAL(chip access Failure) 

BCM_E_MCAST_NOT_FOUND(address not found (mcaddr not filled in)) 

int bcm_mcast_leave(int unit, unsigned char *mcMacAddr, int vlanId, int srcPort) 

DESCRIPTION This function removes the given port from the group membership of the given 

mcast mac address. 




INPUT 


mcMacAddr Multicast Address from which the member is to be removed 

vlanId Vlan ID 

srcPort Port to be removed from the membership of the given multicast address 

RETURN VALUE 

BCM_MCAST_LEAVE_DELETED (If the entry with the given 

mcast addr is deleted from H/W table) 

BCM_MCAST_LEAVE_UPDATED (If the mcast address is 

found in the table and bitmap is updated) 

BCM_MCAST_LEAVE_NOTFOUND (If the mcast address is 

not found in the table) 

BCM_E_INTERNAL (If L2 mcast table search/insert 

fails) 

Note: BCM_MCAST_xxx values are non-negative Success codes. 

int bcm_mcast_join(int unit, unsigned char *mcMacAddr, int vlanId, int srcPort, mcast_addr_t 

*mcaddr, unsigned int *allRouterBmp) 

DESCRIPTION This function adds the given port to the membership of the given mcast mac 

address 


INPUT 


mcMacAddr Multicast Address to which the new member is to be added 



vlanId Vlan ID 

srcPort Port to be added as a new member of the given multicast address 

mcaddr Used for returning updated entry in mcast table with the given mcast mac 

address 

allRoutersBmp Used for returning the all routers bitmap 

RETURN VALUE 

Mirror APIs 

int bcm_mirror_mode(int unit, int mode) 

BCM_MCAST_JOIN_ADDED (If a new entry is created for the given mcast 

address) 

BCM_MCAST_JOIN_UPDATED (If the mcast address is found in the table 

and bitmap is updated) 

BCM_E_INTERNAL (If L2 mcast table search/insert fails) 

Note: BCM_MCAST_xxx values are non-negative Success codes. 

Mirroring is a feature in which the switch the copies the packet to any port, 

you specified, apart from the normal action which will be taken on the packet. 

This feature can be used in sniffing and analyzing or debugging any problem. 

The BCM switch Mirror APIs allow you to mirror packets at ingress or egress 

of any ports. You can also set the port to which the packets that are mirrored, 

will be sent. 

The mirror APIs supported are displayed in the sections below. 

DESCRIPTION Enables or disables different modes of mirroring 

INCLUDE src/tulsi_drivers/bcm_cli_kern/mirror.h 

INPUT 




mode Either of MIRROR_L2 , MIRROR_L2_L3 or MIRROR_DISABLE 

RETURN VALUE 

int bcm_mirror_to_set(int unit, int port) 



DESCRIPTION Sets the mirror-to port for all mirroring 


INPUT 


port The port to mirror all ingress/egress selections 

RETURN VALUE 

int bcm_mirror_to_get(int unit, int *port) 


BCM_E_INTERNAL(Chip access Failure) 

DESCRIPTION Gets the mirror-to port for all mirroring 


INPUT 


port (OUT) The port to mirror all ingress/egress selections to 



RETURN VALUE 



int bcm_mirror_ingress_set(int unit, int port, int val) 

DESCRIPTION Enables or disables mirroring per ingress 


INPUT 


port The port to affect 

val Boolean value for on/off 

RETURN VALUE 



Note: Mirroring must also be globally enabled. 

int bcm_mirror_ingress_get(int unit, int port, int *val) 

DESCRIPTION Gets the mirroring per ingress enabled/disabled status 


INPUT 


port The port to check 

val Place to store boolean return value for on/off 



RETURN VALUE 



int bcm_mirror_egress_set(int unit, int port, int val) 

DESCRIPTION Enables or disables mirroring per egress 


INPUT 


port The port to affect 

val Boolean value for on/off 

RETURN VALUE 



int bcm_mirror_egress_get(int unit, int port, int *val) 

Note: Mirroring must also be globally enabled. 

DESCRIPTION Gets the mirroring per egress enabled/disabled status 


INPUT 


port The port to check 

val Place to store boolean return value for on/off 



RETURN VALUE 

CoSQ Management APIs 


int bcm_cosq_config_set(int unit, int numcos) 


The BCM switch has provided APIs to configure the scheduling of packets at 

egress ports. The number of CoSQs (Class of Service queues) at each egress 

ports can also be configured. The 802.1p priority of the packet can also be 

made to map into any of these queues. You can choose the scheduling algorithms 

for your packets in these COS queues and additionally, weight and the 

latency can be set using the maximum delay. 

The supported CoSQ management APIs are described in the sections below. 

DESCRIPTION Sets the number of CoS queues 

INCLUDE src/tulsi_drivers/bcm_cli_kern/cos.h 

INPUT 


numcos Number of cosq (1, 2, or 4) 

RETURN VALUE 


int bcm_cosq_config_get(int unit, int *numcos) 


DESCRIPTION Gets the number of CoS queues 




INPUT 


numcos (Output) number of CoS queues 

RETURN VALUE 



int bcm_cosq_mapping_set(int unit,int priority, int queue) 

DESCRIPTION Determines which CoS queue a given priority should fall into 


INPUT 


priority Priority value to map 

queue COS queue to map to 

RETURN VALUE 



int bcm_cosq_mapping_get(int unit,int priority, int *queue) 

DESCRIPTION Determines which CoS queue a given priority currently maps to 


INPUT 


priority Priority value 



queue (Output) COS queue number 

RETURN VALUE 


BCM_E_INTERNAL 

int bcm_cosq_sched_set(int unit,int mode, int weights[], unsigned int delay) 

DESCRIPTION Sets up class-of-service policy and corresponding weights and delay 


INPUT 


mode Scheduling mode can be BCM_COSQ_STRICT, 

BCM_COSQ_WEIGHTED_ROUND_ROBIN, or 

BCM_COSQ_BOUNDED_DELAY 

weights Weights for each COS queue 

Unused if mode is BCM_COSQ_STRICT. 

Indicates number of packets sent before going on to the next COS queue. 

delay Maximum delay in microseconds before returning the round-robin to the highest 

priority COS queue (Unused if mode other than 

BCM_COSQ_BOUNDED_DELAY) 

RETURN VALUE 



int bcm_cosq_sched_get(int unit,int *mode,int weights[], unsigned int *delay) 

DESCRIPTION Retrieves class-of-service policy and corresponding weights and delay 




INPUT 

Flash API 


mode (output) Scheduling mode i.e. BCM_COSQ_STRICT, 

BCM_COSQ_WEIGHTED_ROUND_ROBIN, or 

BCM_COSQ_BOUNDED_DELAY 

weights (Output) Weights for each CoS queue unused if mode is 

BCM_COSQ_STRICT. 

delay (Output) Maximum delay in microseconds before returning the round-robin to 

the highest priority COS queue, unused if mode other than 

BCM_COSQ_BOUNDED_DELAY. 

RETURN VALUE 



int frc_cpci910_flash_read_mac(char *mac_addr, int number, int offset) 

DESCRIPTION This API reads flash addresses of various devices on the board 

INCLUDE src/tulsi_drivers/flash_burner/include/flash_burner.h 

INPUT 

number Number of mac addresses to be read 

mac_addr Mac address that has been read from the flash 

offset Index to the mac address buffer in the flash 

RETURN VALUE 



Watchdog APIs 

0 (Success) 

-ve (Failure) 

Supported APIs The supported watchdog APIs are described in the following sections 

int frc_cpci910_watchdog_arm_shortdog( void ) 

DESCRIPTION This arms the shortdog enabling it to RESET the board if not refreshed before 

timeout. The board resets if the shortdog is not refreshed periodically once it 

is armed. 

INDLUDE src/tulsi_drivers/watchdog/watchdog.h 

int frc_cpci910_watchdog_refresh_shortdog( void ) 

DESCRIPTION This refreshes the shortdog. The period to refresh should be within 200 ms 

once the shortdog is armed or refreshed. 


int frc_cpci910_watchdog_disarm_shortdog( void ) 

DESCRIPTION This disarms the shortdog. This will disable the shortdog to cause board 

RESET . 

Once the shortdog is armed, it should be refreshed periodically (around 

100ms) so as to not cause a board reset. The Linux timer functions can be used 

to call the frc_cpci910_watchdog_refresh_shortdog() function. 





A 

Error Codes

Error Codes Error Codes 

Error Codes 

The error codes that can be returned by Extended API routines are detailed here. The return values 

of each API call description indicates which error codes may be returned by the call. 

Certain API calls propagate error codes from the lower level functions for which return codes may 

vary. In this case it is not practical to list all of the possible return values. This condition is indicated 

by the notation BCM_E_XXX. 

Any error code returned by an API call may be turned into a printable string by passing it to 

bcm_errmsg (). 

Error Code Error Number Cause 

BCM_E_AUTOEG_BUSY -6 Auto-negotiation is in progress 

BCM_E_AUTONEG_DISABLE -5 Attempted to get rem ote properties, but 

auto negotiation is not enabled 

BCM_E_AUTONEG_ERROR -7 Auto negotiation error or remote default 

BCM_E_DEFIP_TBL_EMPTY -61 Default table empty 

BCM_E_DEFIP_TBL_FULL -60 Default IP table is full 

BCM_E_DUP_INSERT -48 Duplicated insertion 

BCM_E_FILTER_MASK_NOT_ 

FOUND 

BCM_E_FILTER_RULE_NOT_ 

FOUND 

Filter mask not found 

Filter rule not found 

BCM_E_HANDLER_BUSY -45 Sw packet handler busy 

BCM_E_HANDLER_NOT_FO 

UND 

-44 Sw packet handler not found 

BCM_E_INIT -25 Module is not initialized 

BCM_E_INTERNAL -3 Unexpected internal error 

BCM_E_INVALID_INDEX -47 Invalid module or table index 

BCM_E_L2_NOT_FOUND -41 L2 address not found 

CPCI-910 A - 3



BCM_E_L3_NOT_FOUND -42 L3 address not found 

BCM_E_TBL_L3_EMPTY L3 table empty 

BCM_E_L3INF_TBL_EMPTY -56 L3 INF Table Empty 

BCM_E_L3INF_TBL_FULL -55 L3 INF Table Full 

BCM_E_MASK_MAX -43 Maximum number of filter masks already 

allocated 

BCM_E_MASK_TBL_FULL Mask table full 

BCM_E_MCAST_NOT_FOUN 

D 

-49 Multicast entry not found 

BCM_E_MEMORY -9 Internal out of memory 

BCM_E_MII_TIMEOUT -2 MII register access time-out 

BCM_E_NONE 0 No error ---- operation Successful 

BCM_E_NOT_IMPL -4 The requested operation is not implemented, 

or is unavailable on this chip 

BCM_E_PARAM -26 Illegal or bad parameter detected 

BCM_E_PORT -27 Illegal port number 

BCM_E_PORT_EXISTS -29 Requested port already exists 

BCM_PORT_NOT_FOUND -28 Requested port could not be found 

BCM_E_SCHAN_TIMEOUT -1 Internal register or memory access timeout 

BCM_E_TBL_FULL Table full 

BCM_E_TRUNK_ID -36 Illegal trunk ID. 

BCM_E_TRUNK_MAX -37 Trunk already contains maximum number of 

ports. 

BCM_E_UNIT -13 Requested unit not attached or out of range. 

BCM_E_UNTAG_CONFLICT -46 Untagged ports must be subset of ports. 

BCM_E_VLAN_EXISTS -32 VLAN ID already exists. 

A - 4 CPCI-910



BCM_VLAN_ID VLAN ID is invalid. 

BCM_E_VLAN_IF_CONFLICT -35 VLAN contains ports with conflicting ingress 

filter modes. 

BCM_E_VLAN_MAX -33 Maximum number of VLANs has already been 

defined. 

BCM_E_VLAN_NOT_FOUND -31 VLAN ID not found. 

CPCI-910 A - 5


A - 6 CPCI-910

B 

Project Configuration and Example Design

Project Configuration and Example Design Project Configuration and Example Design 

Project Configuration and Example Design 

This appendix details how to build the project, configure and modify the example design for the 

microcode loader. 

Note: 

• Ensure that you have the Intel ® IXP1200 SDK 2.01.112.Workbench installed. 

• It is presumed that you are familiar with using Intel ® IXP1200 SDK 2.01.112.Workbench. 

• Refer to the Intel ® IXP1200 Network Processor Family Development Tool User’s Guide for 

information on how to use the Workbench. 

Building Project 

To build the project, invoke the Intel ® IXP1200 SDK 2.01.112.Workbench. Follow the steps detailed 

here to configure the project and modify the example design. To build and configure your project do 

the following: 

Create a New Project 

Insert Assembler Files 

Build Setup 

Create a New Project 

To create a new project follow these steps: 

1. Open the Intel ® IXP1200 Developer Workbench. 

2. Select File=>New Project. The New Project dialog window opens. Enter the values as 

specified here in each of the available fields: 

Field (box) Action required 

Project name Enter the name of the project. 

Location Specify the folder in which you want to store the project. It is suggested you 

specify project folder in the following directory: 

%ixp1200/microcode/workbench_projects. 

If the folder that you specify in the above directory does 

not exist, Workbench creates it for you. 

Specify chip type Select the IXP1250 with CRC and ECC radio button. 

CPCI-910 B - 3


3. Click OK to save the new project settings and close the New Project window. 

4. Unzip all the source code files from the zip file provided for installation to your project 

directory. 

Insert Assembler Files 

1. From the File menu, select Project=>Insert assembler source files. The Insert Assembler 

Source Files into Project window opens. 

2. Browse to the project directory and select the following files: 

•Ixplib.uc 

•Rx_rl_ether1gig.uc 

•Tx_rl_ether1gig.uc 

3. Click OK to include the selected files for the project. 

Build Setup 

1. From the File menu, select Build=>Settings. The Build Settings window opens. 

2. Click the General tab. 

a) Assembler include directories 

Type the project directory path name to include all header and source files. You can also use 

the browse button provided. In order to display the browse button, double- click in the 

“Assembler include directories” box. 

b) Specify the range of processor revisions on which you want the linked code to run: 

Set: 

Minimum revision to “1” 

Maximum revision to “no limit”. 

3. Click the Assembler tab. 

a) Click the [New] button to specify the new output to the .list file. The Insert New List File 

into Project dialog box appears. 

b) Insert these files: 

•rec_f0 list 

•rec_f1.list 

•xmit_f4.list 

B - 4 CPCI-910


c) Associate root files for the corresponding list files: 

List File Root File 

rec_f0.list rx_rl_ether1gig.uc 

rec_f1.list rx_rl_ether1gig.uc 

xmit_f4.list tx_rl_ether1gig.uc 

d) Select the following Assembler Options: 

•Optimize to turn on Assembler optimizations 

•Produce debug info to add debug information to the output file. Select this option to open a thread 

window in the debug mode. 

e) Specify the following in Preprocessor Definitions 

List File Preprocessor Definitions 

rec_f0.list UENGINE_ID=0 

rec_f1.list UENGINE_ID=1 

xmit_f4.list UENGINE_ID=4 

6. Click the Linker tab. 

a) Specify the following: 

Microengine Select this List File 

Microengine 0 rec_f0.list 

Microengine 1 rec_f1.list 

Microengine 4 xmit_f4.list 

b) Select the check box for Produce Debug Info. 

3. Click [OK] to save the Build Settings. 

Build Setup is now complete and you can compile the project. 



Example Design 

The Example Design demonstrates the use of the Intel ® IXP Processor on CPCI-910. The application 

is designed to receive and transmit data packets received from the switch. The example design 

software consists of initialization code that executes on the Intel StrongARM* core and packet 

processing code that executes on three of the six Microengines. The Microengine code is written in 

IXP1200 microengine assembly language. 

Note: 

• It is assumed you are familiar with IXP1200 architecture, features, operation, and Intel 

IXP1200 Network Processor Development Environment. For more information refer to Intel ® 

Gigabit Ethernet Example Design. 

• The Gigabit Ethernet Example Design is an example application, designed to send and 

receive IP packets to and from Linux TCP/IP stack. It has not been verified for compliance 

against the applicable standards (such as TCPIP). Use this as a starting point for application 

design since this has been tested only in the hardware environment. 

Code snippets from the example design are included in the description. The code snippets 

demonstrate implementation of particular features. The Gigabit Ethernet Example Design 

demonstrates one method of how such an application may be implemented. The design uses the 

features and resources of the IXP1200. The design offers a methodology for designing applications 

for high data-rate packet processing. 

Modifying Example Design 

The example microcode in the present design transfers all the packets received on the IXbus to the 

SA core using a linked list data structure. There is no support to handle the port, which is not 

connected to the switch. 

Note: For further details refer to the Intel ® IXP1200 Network Processor Gigabit Ethernet Example 

Design Application Note provided with provided with the Intel ® IXP1200 SDK2.01.112. 

Receive Processing for Receive Microengine 

The example design provided with this release assumes prior knowledge of Gigabit Ethernet 

Example as described in Intel ® IXP1200 SDK 2.01.112. The code segments in this section can be 

found in rx_rl_ether1gig.uc file. 

On reception of the SOP packet the example design places the packet placed in RFIFO in the 

SDRAM. 

The following code segment does the following: 



Line 1: dram_rfifo_read (packet_buf_addr, QWOFFSET0, rfifo_addr, QWOFFSET0, 

QWCOUNT8, sig_done); 

Line 2: shf_left (output_intf, CORE_STACK_INTF1, 3); 

Line1: This piece of code reads the 64 byte packet from RFIFO starting from the element number 

given by rfifo_addr and puts the read packet into the SDRAM at an address specified by the GPR 

packet_buf_addr. 

Line2: This piece of code then indicates that the packet is meant for the SA core. 

To transfer the packet to a port other than SA core, modify the code as shown: 

shf_left (output_intf, FAST_PORT_LO/FAST_PORT_HI,3); 

The output_intf can be either of the FAST PORTS. In this example code, the output_intf is 

core port, which is assigned a value of 18. To send packets to a port other than CORE OR 

FAST_PORT define NEW_PORT and use it. 

Transmitting Packets for Receive Microengine 

After the receive thread finishes processing an Ethernet frame, it uses linked list data structure to 

pass the packet information to the SA core. 

Note: Refer to rx_rl_ether1gig.uc file for more information on code segments. 

When the Receive Thread is ready to place the frame onto the transmission queue, it does so by writing 

the 2-word descriptor to the queue entry. The following Code Point highlights the instructions 

used to place a frame onto the queue. 

To transfer the packet to a port other than SA core, modify the code as shown: 

.if (output_intf == FAST_PORT_LO_INTF) 

sram_write ($desc_buf[0],XMIT_FPORT_DESCRIPTOR_BASE_X, $desc_buf[2], LWCOUNT2, 

ctx_swap); 

.endif 

where: 

The output_intf can be defined as either FAST PORT1 or FAST_PORT2. 

The circular queue base address (XMIT_FPORT_DESCRIPTOR_BASE_X) can vary for different 

ports. 



Transmitting Packet Details for Transmit Microengine 

The SA core inserts an Ethernet frame to a circular transmit queue beginning at a location in SRAM 

(XMIT_FPORT_DESCRIPTOR_BASE_1 =0x1000) and increments a Transmit Element Count in 

Scratchpad memory. The Scheduler in Microengine 4 reads the counter located at the Scratchpad 

address XMIT_FPORT1_ELE_COUNT. 

The counter is compared by the Scheduler with an internal counter to determine if a new frame is 

ready to be transmitted. The Scheduler maintains the internal counter in the absolute register 

@assigned_mpkt_cnt. 

The Scheduler modifies this counter when a new frame is on the queue. When a frame contains 

multiple Mpackets, the Fill Threads modify the frame. 

Assignment registers are used by the Scheduler to communicate to each of the Fill Threads in the 

Microengine . There is a set of three absolute registers. Each Fill thread in the Microengine has a 

absolute register. The names of the three absolute registers are: 

•@assign1 

•@assign2 

•@assign3. 

When the Fill threads get an assignment from the scheduler, they read the circular queue to get the 

address of the SDRAM location where the packet has been placed. The macro 

tx_packetlink_read_cirq_nik dequeues the packet from the circular queue and sends it on 

the IXbus. 

The above macro can be found in tx_rl_ether1gig_fill.uc file. 


Index of Functions 

F 

Functions 

enum cardtype bcm_check_card_type() 2- 

54 

extern int bcm_l3_status() .................. 2-60 

int bcm_cosq_config_get() ................. 2-76 

int bcm_cosq_config_set() .................. 2-76 

int bcm_cosq_mapping_get() ............. 2-77 

int bcm_cosq_mapping_set() ............. 2-76 

int bcm_cosq_sched_get() .................. 2-78 

int bcm_cosq_sched_set() ................... 2-77 

int bcm_filter_action_match() ............ 2-18 

int bcm_filter_create() ........................ 2-15 

int bcm_filter_destroy() ...................... 2-16 

int bcm_filter_install() ........................ 2-19 

int bcm_filter_qualify_data() ............. 2-18 

int bcm_filter_qualify_egress() .......... 2-17 

int bcm_filter_qualify_priority() ........ 2-16 

int bcm_filter_reinstall() ..................... 2-19 

int bcm_filter_remove() ...................... 2-15 

int bcm_l2_addr_add() ....................... 2-11 

int bcm_l2_addr_remove_by_port() .... 2-9 

int bcm_l2_addr_remove_by_trunk() 2-10 

int bcm_l2_addr_remove_by_vlan() .. 2-10 

int bcm_l3_defip_add() ...................... 2-64 

int bcm_l3_defip_delete() ................... 2-64 

int bcm_l3_defip_delete_by_interface() ..... 

................................................. 2-65 

int bcm_l3_defip_find_index() ........... 2-67 

int bcm_l3_defip_get() ....................... 2-66 

int bcm_l3_defip_update() ................. 2-65 

int bcm_l3_interface_create() ............. 2-58 

int bcm_l3_interface_destroy() ........... 2-59 

int bcm_l3_interface_update() ........... 2-59 

int bcm_l3_ip_add() ........................... 2-60 

int bcm_l3_ip_delete() ........................ 2-61 

int bcm_l3_ip_delete_all() .................. 2-63 

int bcm_l3_ip_delete_by_index() ....... 2-62 

int bcm_l3_ip_delete_by_interface() .. 2-62 

int bcm_l3_ip_delete_by_prefix() ...... 2-61 

int bcm_l3_ip_find() ...........................2-63 

int bcm_mcast_addr_add() .................2-68 

int bcm_mcast_addr_remove() ...........2-69 

int bcm_mcast_join() ...........................2-71 

int bcm_mcast_leave() ........................2-70 

int bcm_mcast_port_get() ...................2-69 

int bcm_mirror_egress_get() ..............2-75 

int bcm_mirror_egress_set() ...............2-74 

int bcm_mirror_ingress_get() .............2-74 

int bcm_mirror_ingress_set() ..............2-73 

int bcm_mirror_mode() ......................2-72 

int bcm_mirror_to_get() .....................2-73 

int bcm_mirror_to_set() ......................2-72 

int bcm_packet_send_async() .............2-39 

int bcm_packet_send_sync() ...............2-38 

int bcm_port_autoneg_get() ...............2-42 

int bcm_port_autoneg_set() ................2-43 

int bcm_port_bringup() ......................2-53 

int bcm_port_duplex_get() .................2-44 

int bcm_port_duplex_set() ..................2-45 

int bcm_port_learn_get() ....................2-51 

int bcm_port_learn_modify() .............2-52 

int bcm_port_learn_set() .....................2-51 

int bcm_port_link_status_get() ...........2-42 

int bcm_port_linkscan_get() ...............2-40 

int bcm_port_linkscan_set() ...............2-41 

int bcm_port_loopback_get() ..............2-48 

int bcm_port_loopback_set() ..............2-48 

int bcm_port_pause_addr_get() .........2-47 

int bcm_port_pause_addr_set() ..........2-47 

int bcm_port_pause_get() ...................2-46 

int bcm_port_pause_set() ...................2-46 

int bcm_port_shutdown() ...................2-53 

int bcm_port_speed_get() ...................2-43 

int bcm_port_speed_set() ...................2-44 

int bcm_port_stp_get() .......................2-49 

int bcm_port_stp_set() ........................2-50 

int bcm_port_vlan_get() .....................2-37 

int bcm_stk_init() ................................2-35 

int bcm_stk_port_get() ........................2-36 

int bcm_stk_port_is_stack() ................2-36 

CPCI-910 I - 1

int bcm_trunk_bitmap_expand() ........2-33 

int bcm_trunk_broadcast_port_get() ..2-31 

int bcm_trunk_create() ........................2-29 

int bcm_trunk_destroy() .....................2-32 

int bcm_trunk_get() ............................2-33 

int bcm_trunk_info_get() ....................2-30 

int bcm_trunk_mcast_join() ................2-32 

int bcm_trunk_psc_get() .....................2-30 

int bcm_trunk_set() .............................2-31 

int bcm_trunk_use_tid() .....................2-29 

int bcm_vlan_create() ............................2-4 

int bcm_vlan_destroy() .........................2-5 

int bcm_vlan_destroy_all () ..................2-6 

int bcm_vlan_port_add() ......................2-7 

int bcm_vlan_port_get() ........................2-8 

int bcm_vlan_port_remove() ................2-7 

int cmic_pci_getreg() ..........................2-26 

int cmic_pci_setreg() ...........................2-26 

int cmic_read_miim() ..........................2-23 

int cmic_read_reg() .............................2-27 

int cmic_write_miim() ........................2-23 

int cmic_write_reg() ............................2-28 

int filter_dump() .................................2-20 

int filter_qualify_ingress() ..................2-17 

int frc_cpci910_flash_read_mac() .......2-79 

int frc_cpci910_watchdog_arm_shortdog() 

2-79 

int 

frc_cpci910_watchdog_disarm_shortdog() 

2-80 

int 

frc_cpci910_watchdog_refresh_shortdog() 

2-80 

int l2_addr_get() ..................................2-13 

int l2_addr_remove() ..........................2-13 

int l2-addr_add() .................................2-11 

int PCI_config_read() ..........................2-25 

int PCI_config_write() .........................2-25 

int port_vlan_set() ...............................2-37 

unsigned int cmic_irq_disable() .........2-24 

unsigned int cmic_irq_enable() ..........2-24 

I - 2 CPCI-910

Product Error Report 

Product: Serial No.: 

Date Of Purchase: Originator: 

Company: Point Of Contact: 

Tel.: Ext.: 

Address: 

Present Date: 

Affected Product: 

o Hardware o Software o Systems 

Error Description: 

This Area to Be Completed by Force Computers: 

Date: 

PR#: 

Affected Documentation: 

o Hardware o Software o Systems 

Responsible Dept.: o Marketing o Production 

Engineering ‡ o Board o Systems 

+ Send this report to the nearest Force Computers headquarter listed on the address page.

CPCI-910 Programmer's Guide - Emerson Network Power

Create successful ePaper yourself

Delete template?

Save as template?