English dropdown-ico

Intel IXP400 manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

Go to page of

Similar user manuals

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of Intel IXP400, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of Intel IXP400 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of Intel IXP400. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of Intel IXP400 should contain:
- informations concerning technical data of Intel IXP400
- name of the manufacturer and a year of construction of the Intel IXP400 item
- rules of operation, control and maintenance of the Intel IXP400 item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of Intel IXP400 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of Intel IXP400, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the Intel service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of Intel IXP400.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the Intel IXP400 item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    Intel ® IXP400 Digit al Signal Processing (DSP) Sof tware Ve r s i o n 2 . 5 API Reference Manual December 2004 Document Number: 273811-00 7a[...]

  • Page 2

    2 API Reference Manual INFORMA TI ON IN THIS DOCUME NT IS PROVIDE D IN CONNECTION W ITH INTEL ® PRODUCTS. EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LI ABILITY WHA TSOEVER, AND INTEL DISCLAI MS ANY EXPRESS OR IMPLIED WARRANTY RELA TING TO SALE A ND/OR USE OF INTEL PRODUCTS, INCLUDING LIABILI[...]

  • Page 3

    API Reference Manual 3 Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Contents 1.0 Introduction ............... ............. ................ ............. ............. ................ ............. ......... 7 1.1 General...... ............. ............ ................. ............. ................ ............. ...[...]

  • Page 4

    4 API Reference Manual Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 6.8 Tone Detector Receive-FSK Message ... ... ................ ............. ............. ........... 32 6.9 Tone Detector FSK-Receive-Complete d Message ................... ................... .. 33 6.10 Player-Start Message ......................... ...[...]

  • Page 5

    API Reference Manual 5 Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Revision History Date Revision Description December 2004 008 Updated product branding. September 2004 007 Further updates for the release of Intel ® IXP400 DSP Software v2.5. Change bars indicate areas of change. June 2004 006 Updates for the release of [...]

  • Page 6

    6 API Reference Manual Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 This p age intentionally lef t blank.[...]

  • Page 7

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Introduction API Reference Manual 7 1.0 Introduction The Intel ® IXP400 DSP Soft ware v2.5 is a software module that provi des the basic voice processing functionalities for V oIP residential gateway applicat ions. It can be viewed as a completed media pro- cessing layer with [...]

  • Page 8

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Introduction 8 API Reference Manual NLP Non-linear Pro cessing (for EC) SP Signal Processing V AD V oice Activity Detection[...]

  • Page 9

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Architectural Ov erview API Reference Manual 9 2.0 Architectural Overview Intel ® IXP400 DSP So ft ware is implemented as an indep endent module havi ng its own t asks and runtime environmen t. The software architecture is of a two-layer hier archy – a control layer that pro[...]

  • Page 10

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Media Processing Resource Compon ent s 10 API Reference Manual 3.0 Media Processing Resource Component s As shown in Figure 1 , the add ressable control entities of Intel ® IXP4 00 DSP Software are media processing resource (MPR) components similar to those de fined in many Int[...]

  • Page 11

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Media Processing Re source Component s API Reference Manual 11 Parameters Event s • XEVT_NET_HOOK_STATE — Hook state ch ange detected. • XEVT_NET_TIMER — T imer expired. 3.2 Decoder Resource Component Resource T ype: XMPR_DEC Identifier Description, V alues Attr . Direc[...]

  • Page 12

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Media Processing Resource Compon ent s 12 API Reference Manual Media Processing Functions • Decoding • Automatic leve l control and/or volu me control • Comfort noise generation • Jitter compensation Resource-Specific Control Messages • XMSG_CODER_START (inbound) • X[...]

  • Page 13

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Media Processing Re source Component s API Reference Manual 13 Event s • XEVT_LOST_PACKET – Bad or lo st p acket . • XEVT_DEC_PACKET_CHNG – R TP pay load ty pe changed. 3.3 Encoder Resource Component Resource T ype: XMPR_ENC Media Processing Functions • Encoding • A[...]

  • Page 14

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Media Processing Resource Compon ent s 14 API Reference Manual Parameters Event s • XEVT_LOST_PACKET — Bad packet. • XEVT_DEC_PACKET_CHNG — Received R TP payload type changed. Identifier Description and values Attr . Direct Wri te XP ARMID_RES_ST A TE Current state (0: i[...]

  • Page 15

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Media Processing Re source Component s API Reference Manual 15 3.4 T one Generation Resource Component Resource T ype: XMPR_TNGEN Media Processing Functions • Generating multiple frequency tone signals • Generating call progress tones Resource-Specific Control Messages • [...]

  • Page 16

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Media Processing Resource Compon ent s 16 API Reference Manual 3.5 T one Detection Resource Component Resource T ype: XMPR_TNDET Media Processing Functions • Receiving DTMF digits • Detecting individual tone event Resource-Specific Control Messages • XMSG_TD_RCV (inbound) [...]

  • Page 17

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Media Processing Re source Component s API Reference Manual 17 Event s • XEVT_CODE_TD_TONEON – tone on event for an individual tone • XEVT_CODE_TD_TONEOFF – tone of f event for an individual ton e Event data1 gives the tone ID and data2 give s th e time stamp in 10-ms u[...]

  • Page 18

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Media Processing Resource Compon ent s 18 API Reference Manual Media Processing Functions Mixing multiple audio streams for three-way call or small audio conference. The maximum number of parties to the mixer is currently five. Resource-Specific Control Messages None. Parameters[...]

  • Page 19

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Media Processing Re source Component s API Reference Manual 19 Event s XEVT_T38_END — End of the T .38 session. Event Data 1 gives the reason of the termi nati on. 3.9 Message Agent Resource Component Resource T ype: XMPR_MA Media Processing Functions • No media pr ocessing[...]

  • Page 20

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Message Format and Delivery Mech anism 20 API Reference Manual 4.0 Message Format and Delivery Mechanism There are two message queues (in-bound and out-bound ) fo r the user application to send control messages and to receive response and event message s, respectively . The mess[...]

  • Page 21

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Message Forma t and Delivery Mecha nism API Reference Manual 21 4.2 Message Header Format Return • XSUCC — If successful • XERROR — If errors Caution Message buffer requires 4-byte alignment. Note The message buffer can be used for any other purpose, a fter posting. For[...]

  • Page 22

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Message Format and Delivery Mech anism 22 API Reference Manual 4.3 Message T ype List All message types are pre-defin e d as: Typedef enum{ XMSG_BEGIN =0, /* Begin list */ XMSG_RESET, /* reset a resource */ XMSG_START, /* start media processing a SP resource */ XMSG_STOP, /* sto[...]

  • Page 23

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Common Control Message API Reference Manual 23 5.0 Common Control Message This section defines the control messages that can be applied to all the resources. 5.1 Reset Message 5.2 S t art Message Ty p e XMSG_RESET Direction Inbound Description S tops the current action and rese[...]

  • Page 24

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Common Control Message 24 API Reference Manual 5.3 Stop Message 5.4 Ping Messa ge 5.5 Set-Parameter Message Ty p e XMSG_ST OP Direction Inbound Description S tops the current action. Format typedef struct{ XMsgHdr_t head; /* message header */ } XMsgStop_t; Macro #define XMSG_MAK[...]

  • Page 25

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Common Control Message API Reference Manual 25 5.6 Set-Multiple-P arameter Message Format typedef struct{ XMsgHdr_t head; /* message header */ UINT16 parmId; /* parameter id */ UINT16 value; /* parameter value */ } XMsgSetParm_t; Macro #define XMSG_MAKE_SET_PARM(p Msg, trans, r[...]

  • Page 26

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Common Control Message 26 API Reference Manual 5.7 Get-Parameter Message 5.8 Get-Parameter Acknowledge Message 5.9 Get-All-Parameters Message Ty p e XMSG_GET_P ARM Direction Inbound Description Get s a parameter from a resource. Format typedef struct{ XMsgHdr_t head; /* message [...]

  • Page 27

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Common Control Message API Reference Manual 27 5.10 Get-All-Parameters Acknowledge Message 5.1 1 General-Acknowledge Message Format typ edef struct{ XMsgHdr_t head; /* message header */ } XMsgGetAllParms_t; Macro #define XMSG_MAKE_GET_ALLPAR MS(pMsg, trans, res, inst) { XMSG[...]

  • Page 28

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Common Control Message 28 API Reference Manual 5.12 Error Message 5.13 Event Message Ty p e XMSG_ERROR Direction Outbound Description Resource reports an error condition. (See constant data section for error codes.) Format typedef struct{ XMsgHdr_t head; /* message header */ UIN[...]

  • Page 29

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Resource-S pecific Co ntrol Message s API Reference Manual 29 6.0 Resource-S pecific Control Messages This section defines the resource-specific messages. 6.1 CODEC S t art Message 6.2 CODEC Stop-Ackno wledgement Message Ty p e XMSG_COD ER_ST ART Direction Inbound Description S[...]

  • Page 30

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Resource-Specifi c Co n tro l Me ss ag e s 30 API Reference Manual 6.3 T o ne Gen erator Play Message 6.4 T one Generator Play-FSK Message Ty p e XMSG_TG_PLA Y Direction Inbound Description R equires T one Generator to play a tone string . (T one ID’s are listed in the constan[...]

  • Page 31

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Resource-S pecific Co ntrol Message s API Reference Manual 31 6.5 T one Generator Play-Completed Message 6.6 T one Detector R eceive-Digit Message Ty p e XMSG_TG_PLA Y_CMPL T Direction Outbound Description T one Ge nerator indicates the completion of playing tones. Format typed[...]

  • Page 32

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Resource-Specifi c Co n tro l Me ss ag e s 32 API Reference Manual 6.7 T one Detector Receive-Completed Message 6.8 T one Detector Receive-FSK Message Ty p e XMSG_TD_RCV_CMPL T Direction Outbound Description T one d etector indicates the completion of receiving DTMF tones. Forma[...]

  • Page 33

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Resource-S pecific Co ntrol Message s API Reference Manual 33 6.9 T one Detector FSK-Rece ive-Completed Message 6.10 Player-St art Message Ty p e XMSG_TD_RCV_FSK_CMPL T Direction Outbound Description T one Detector indica tes the completion of receiving FSK data Format typedef [...]

  • Page 34

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Resource-Specifi c Co n tro l Me ss ag e s 34 API Reference Manual 6.1 1 Player Play-C ompleted Message Format typedef struct{ XMsgHdr_t head; /* message header */ XPlyMediaDesc_t mediaSeg[XM AX_PLY_SE G]; /* media segments to play */ UINT8 numSeg; /* number of segments */ } XMs[...]

  • Page 35

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Resource-S pecific Co ntrol Message s API Reference Manual 35 6.12 Get-Jitter-Buffer -St atistics Message 6.13 Complete Message of Gett ing Jitter Buffer St atistics Ty p e XMSG_GET_JBST A T Direction Inbound Description Get the jitter buffer st at istics from a Decoder instanc[...]

  • Page 36

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Packet Data Interface 36 API Reference Manual 7.0 Packet Dat a Interface The packet data interface is a protocol for the Intel ® IXP400 DSP Software to exchange the encoded data packets with IP stack. This interface is defined as a packet fo rmat and two callback functions – [...]

  • Page 37

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Packet Data Interface API Reference Manual 37 The corresponding data structure is defined as: In ingress, the header in formation of Remote Ti me Stamp, Payload T ype and Marker bi t are directly copied from a R TP packet. In egre ss, the header information is fill ed by DSP so[...]

  • Page 38

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Configuration and Initialization 38 API Reference Manual 8.0 Configuration and Initialization The Intel ® IXP400 DSP Software is config urable at init ialization time, allowing the user to specify the HSS parameters, the number of resource instances to be created and the countr[...]

  • Page 39

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Configuration and Initializat ion API Reference Manual 39 The configuration informatio n in this function is defined as: The pChanTsMap field is an array that specifies how the instances of Network Endpoint are linked with the time slots of HSS. Each el ement of the array is de[...]

  • Page 40

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Configuration and Initialization 40 API Reference Manual Then the array that describes su ch configuration is given as: If the pChanTsMap field is given a NULL pointer , all the instances of Network En dpoint will be con- figured to the narrowband mod e and are lin ked to the ac[...]

  • Page 41

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Configuration and Initializat ion API Reference Manual 41 Wa r n i n g : New tone definition must be added during t he initialization after xDspSysInit() . The pre- defined country-specific call progress tone will be ov erwritten if a new tone is add ed with the same tone ID. 8[...]

  • Page 42

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Configuration and Initialization 42 API Reference Manual Wa r n i n g : New tone detection criterion must be added during the initi al izati on before xDspSysInit() . 8.4 Getting DSP Resource Configu ration and Routi ng Information Description The user ’ s applications can cal[...]

  • Page 43

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Configuration and Initializat ion API Reference Manual 43 data structure XDSPResConfig_t is defined as: The stream ID i nformation is used for the application to connect the T -Ports and L-Ports of the re- sources. typedef struct{ int numChTDM; /* number of TDM termination chan[...]

  • Page 44

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Complement ary Functions 44 API Reference Manual 9.0 Complement ary Functions 9.1 Direct Parameter Access The user ’ s applications can bypass the message and directly access the D SP parameters. This allows quicker access without having to se nd a message and receive a respon[...]

  • Page 45

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Complement ary Functions API Reference Manual 45 The hook states are defined as: 9.3 Cache Prompt Re gistration Output None Return • XSUCC if successful • Otherwise XERROR Description This function is called by the SLIC driver to report the hook state changes via the event [...]

  • Page 46

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 Complement ary Functions 46 API Reference Manual 9.4 Get V ersio n N umber Prototype char * xDspGetVersion(voi d ); Input None Output None Return Pointer to the version string. Description This function returns a six-digit version st ring in ASCII format hard coded in each relea[...]

  • Page 47

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Const ant Dat a API Reference Manual 47 10.0 Const ant Dat a This section lists up the defi nitions for consta nt data such as error codes and event codes. 10.1 Error Codes Errors are re po rted via XMSG_ERROR message with an error code and two error data. The common error code[...]

  • Page 48

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 C o n s ta n t D a ta 48 API Reference Manual 10.2 Event Codes Events are reported via XMSG_EVENT message with an event code an d two event data. The resource specific event codes are defined as: 10.3 T one IDs The DTMF tone IDs used by the T one Generator and Detector are defin[...]

  • Page 49

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Const ant Dat a API Reference Manual 49 The general call-progress tone IDs used by the T one Generator are defined as: Currently only the following specific call progr ess to nes are supported for tone generation: • China (People’ s Republic of China) • Japan • United S[...]

  • Page 50

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 C o n s ta n t D a ta 50 API Reference Manual United St ates Ca ll-Progress T ones China Call-Progress T ones #define COUNTRY_CODE_US 1 /* US country code */ #define US_TID_DIAL RFC_TID_DIAL /* dial tone */ #define US_TID_RING RFC_TID_RING /* ring back tone */ #define US_TID_BUS[...]

  • Page 51

    Intel ® IXP400 Digital Signal Proce ssing (DSP) Softwar e V ersion 2.5 Const ant Dat a API Reference Manual 51 10.4 Other Const ants The coder types used in the XPARMID_DEC_CTYPE and XPARMID_ENC_CTYPE parameters an d the XMSG_CODER_START message are defined as: Mask bits used to specify the coder type subset in Decoder auto-switch parameter are de[...]

  • Page 52

    Intel ® IXP400 Digital Signal Processin g (DSP) Software V ersion 2.5 C o n s ta n t D a ta 52 API Reference Manual Mask bits used to specify th e termination digits in the XMSG_TD_RCV message are defined as: The stop-reasons in the XMSG_TG_PLAY_CMPLT , XMSG_TD_RCV_CMPLT , XMSG_TD_RCV_FSK_CMPLT , and XMSG_PLY_CMPLT messages are defined as: #define[...]