Assign Logical Span ID 0x00A8

You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Assign Logical Span ID 0x00A8

SwitchKit Name

AssignSpan

Type

EXS API and SwitchKit API message

Description

Use this message to map a logical span ID to a physical location. You must assign a unique ID to each span in the system before you can configure any spans or channels.

Sent by

Host

Example Message (SwitchKit Socket Log Output)

In the following socket log output/example message, the host assigns spans in a single node system to offset 00 in a VDAC-ONE card.

00 0D 00 A8 00 00 FF 01 00 01 11 04 A8 01 00

SwitchKit Code

Configuration

AssignSpan (

Node = integer,

Span = integer,

Slot = integer,

Offset = integer

NumChannels = integer);

C Structure

typedef struct {

UBYTE AddrInfo[30];

UBYTE NumChannels;

UBYTE reserved48[222];

} XL_AssignSpan;

C Structure Response

typedef struct {

unsigned short Status;

UBYTE reserved6[13];

UBYTE AddrInfo[30];

UBYTE NumChannels;

UBYTE reserved50[220];

} XL_AssignSpanAck;

C++ Class

class XLC_AssignSpan : public XLC_SlotMessage {

public:

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

// Extended addressing functions

// Assign Span AIB functions

XBYTE getSpan() const;

void setSpan(XBYTE x) ;

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getOffset() const;

void setOffset(UBYTE x);

UBYTE getNumChannels() const;

void setNumChannels(UBYTE x);

};

C++ Class Response

class XLC_AssignSpanAck : public XLC_AcknowledgeMessage {

public:

unsigned short getStatus() const;

void setStatus(unsigned short x);

const UBYTE *getAddrInfo() const;

UBYTE *getAddrInfo();

void setAddrInfo(UBYTE *x);

// Extended addressing functions

// Assign Span AIB functions

XBYTE getSpan() const;

void setSpan(XBYTE x)

UBYTE getSlot() const;

void setSlot(UBYTE x);

UBYTE getOffset() const;

void setOffset(UBYTE x);

UBYTE getNumChannels() const;

void setNumChannels(UBYTE x);

};

EXS API Hex Format

MESSAGE (White)		RESPONSE (Gray)
Byte	Field Description	Byte	Field Description
0	Frame (0xFE)	0	Frame (0xFE)
1, 2	Length (0xNNNN)	1, 2	Length (0xNNNN)
3, 4	Message Type (0x00A8)	3, 4	Message Type (0x00A8)
5	Reserved (0x00)	5	Reserved (0x00)
6	Sequence Number	6	Same Sequence Number
7	Logical Node ID	7	Logical Node ID
:	AIB Address Method 0x00 - Individual AEs	8, 9	Status MSB, LSB 0x007F Software Module Locked See also the Common Response Status Values chapter
	Number of AEs to follow	:	AIB Same as message.
	AE 0x11 Logical/Physical Span To de-assign spans, see AIB below table.		Checksum
	Checksum	:

0x11 Logical Span AIB for De-Assigning Spans

To de-assign a physical span, logical span, or all spans, use the field values as shown in the table below in the Assign Logical Span ID message (0x00A8).

Byte	AIB Field Description
0	Address Method: 0x00
1	Number of AEs: 0x01
2	Address Element: 0x11
3	Data Length: 0x04
		All Spans	Physical Span ID	Logical Span ID
4	Data[0] Logical Span ID, MSB	0xFF	0xFF	Valid Logical Span
5	Data[1] Logical Span ID, LSB	0xFF	0xFF	Valid Logical Span
6	Data[2] Slot	0xFF	Valid Physical Slot	0xFF
7	Data[3] Physical Span	0xFF	Valid Span Offset	0xFF

NOTES:

1. De-assigning a Logical Span ID takes the span, and all channels on the span, out of service.

2. De-assigning a span resets its configuration to the default values. When you want to re-initialize a card’s configuration (for example, when you restart a host application) use the Reset Configuration message.

3. When you de-assign a span, you do not receive a DS0 Status Change message with a Channel Status field value 0x01 (Out of Service) for every channel on the span. Assume that all channels on a de-assigned span are out of service.

4. De-assigning all spans will clean up all virtual slots which acts as if the virtual cards were removed.