Prosody generic: API: sm_get_card_info

Prototype Definition

int sm_get_card_info(struct sm_card_info_parms *cardinfop)

Parameters

a structure of the following type:

typedef struct sm_card_info_parms {
	tSMCardId card;						/* in */
	enum kSMCarrierCardType {
		kSMCarrierCardTypeYetUnknown,
		kSMCarrierCardTypeISAS2,
		kSMCarrierCardTypeBR4,
		kSMCarrierCardTypeBR8,
		kSMCarrierCardTypePCIP1,
		kSMCarrierCardTypePCIC1,
		kSMCarrierCardTypePS,
		kSMCarrierCardTypePX,
	} card_type;						/* out */
	tSM_INT card_detected;					/* out */
	tSM_INT module_count;					/* out */
	tSM_UT32 physical_address;				/* out */
	tSM_UT32 io_address;					/* out */
	tSM_UT32 physical_irq;					/* out */
	char serial_no[kSMMaxSerialNoText];			/* out */
} SM_CARD_INFO_PARMS;

Description

Retrieves information about card hosting Prosody modules installed in system.

On return, card_type will be set to one of the following values:

Card Type	Use
kSMCarrierCardTypeYetUnknown	Card type not yet determined by driver.
kSMCarrierCardTypeISAS2	Obsolete card.
kSMCarrierCardTypeBR4	Obsolete card.
kSMCarrierCardTypeBR8	Obsolete card.
kSMCarrierCardTypePCIP1	Obsolete card.
kSMCarrierCardTypePCIC1	Obsolete card.
kSMCarrierCardTypePS	Prosody S virtual 'card'
kSMCarrierCardTypePX	Prosody X card

The parameter card_detected is obsolete.

The number of modules detected on the card is returned in module_count.

The parameters physical_address , io_address , and physical_irq are obsolete.

Some carrier cards have a machine readable serial number. For such cards the serial number is returned as a zero terminated text string in the character array serial_no.

Fields

card

The card about which information is required

card_type

The type of the card One of these values:

kSMCarrierCardTypeYetUnknown: The card type has not been determined.
kSMCarrierCardTypeISAS2: Obsolete card type.
kSMCarrierCardTypeBR4: Obsolete card type.
kSMCarrierCardTypeBR8: Obsolete card type.
kSMCarrierCardTypePCIP1: Obsolete card type.
kSMCarrierCardTypePCIC1: Obsolete card type.
kSMCarrierCardTypePS: A Prosody S virtual 'card'. This is a software entity which emulates a digital access card and provides a number of channels of telephony via the host's IP (Internet Protocol) communications.
kSMCarrierCardTypePX: A Prosody X card. This is a card which is controlled by IP (Internet Protocol).

card_detected

Obsolete parameter.

module_count

The number of modules on this card.

Obsolete parameter.

Obsolete parameter.

Obsolete parameter.

The serial number of this card.

Returns

0 if call completed successfully, otherwise a standard error such as:

ERR_SM_DEVERR - device error
ERR_SM_BAD_PARAMETER - if no such card exists

This function is part of the Prosody generic API.