zport (3X)

NAME

zport - ACC interface card port configuration

SYNOPSIS

#include  <zcom/zcomsys.h>
#include  <zcom/zcomstatus.h>
#include  <zcom/zcomcall.h> /* if compliled with ANSI C (recommended) */
 
int32 zport (iftno, portno, rcode, action, cnfg, stat)
 
uint32       iftno;
uint32       portno;
uint32       rcode;
uint32       action;
zpconf_type  cnfg
int32        *stat;

DESCRIPTION

Routine zport (action 0-3) configures the datacomm ports on an ACC interface card. This configuration is generally specific to the particular hardware implementation of the card and will vary depending on the card type. It is not usually called from application programs. The calling program (or thread) is suspended while this function is executed. All terminals on the port being changed must be disabled before the port configuration takes place. For example, use zcntl to disable a terminal using rcode 8. Examine your TTGEN configuration file to determine which ports are defined for which ACC interface cards and the terminals associated with each port.

Action 4 is used to activate the Port Break Routine of a the protocol specific firmware. Since Port configuration by-passes the normal terminal transmit queues, this function is used as a software interrupt to the protocol firmware to initiate a recovery process whenever there is a protocol problem and the transmit queues are "blocked up". If the protocol for the specified port does not support this facility, error status 8 is returned in stat.

The libraries libzcom_c.a and libpthread.a must be linked into the calling program by giving the options "-lzcom_c -lpthread" to cc(1) or ld(1).

Threads Considerations

This routine may be called from multi-threaded application using the POSIX (1003.1c) kernel threads API package. It has the following characteristics when called by multi-threaded application:

PARAMETERS

NOTES

/*-- Port Configuration format --*/
 typedef union {
     struct {        /* Port config for all non-E1/T1 cards. */
         unsigned int ecode   : 2;   /* Encoding modes */
         unsigned int sync    : 2;   /* Sync mode select */
         unsigned int mode    : 2;   /* Operating mode */
         unsigned int parity  : 2;   /* Parity select */
         unsigned int xclock  : 2;   /* Clock multiplier */
         unsigned int sclock  : 2;   /* Clock source */
         unsigned int baud    : 4;   /* Baud rate value */
         unsigned int pmode   : 2;   /* Port mode select - original */
         unsigned int pmode2  : 2;   /* Port mode select - extended */
         unsigned int baud2   : 4;   /* Extended baud rate value */
         unsigned int spare   : 8;   /* Reserved, must be 0 */
     } bits;
    struct {         /* E1/T1 port configuration (Z7300A) */
          unsigned int ecode  : 2;    /* Encoding modes */
          unsigned int frmode : 4;    /* Framing mode */
          unsigned int set0_1 : 4;    /* Unused */
          unsigned int sclk   : 2;    /* Clock source */
          unsigned int set0_2 : 4;    /* Unused */
          unsigned int pmode  : 4;    /* Port Mode */
          unsigned int set0_3 : 12;   /* Unused */
     } e1t1_bits;
     int32 pcval;        /* Must be signed, -1 means bad config */
     uint8 pconfig[4];   /* 4 configuration bytes */
 } zpconf_type;

RETURN VALUE

Routine zport returns 0 if successful. Otherwise, a non-zero error code is returned. See /opt/acc/include/zcom/zcomsys.h for the list of ZCOM error codes and their meanings.

When zport returns a zero error code, the return status stat indicates the completion status: zero means successful, while non-zero values indicate the reason for the problem. Note that status code 4, 5, 6, and 7 implies the associated port will now be inoperative. Another zport configuration request must be done to recover it.

EXAMPLE

This example puts an E1/T1 port into "loopback" (tristate) mode.

#include     <zcom/zcomsys.h>
#include     <zcom/zcomcall.h>
 int32          ierr;
 uint32         iftno;
 uint32         portno;
 uint32         rcode;
 uint32         action;
 zpconf_type    cnfg;
 int32          stat;
 
iftno  = 1;     /* ACC MUX number 1 in TTGEN configuration file. */
 portno = 2;     /* Port #2 */
 rcode  = 2;     /* We are providing the configuration in "cnfg". */
 action = ZCOM_ZMUXPORT_PORT;  /* Set only the port mode (Pmode, Pmode2) */
 cnfg.e1t1_bits.pmode = 0x8;
 if (ierr = \fBzport\fR (iftno, portno, rcode, action, cnfg, &stat)) {
      /* error return code */ } else if (stat)
 {
      /* error return code */ } else {
          /* good return code */
 }

FILES

SEE ALSO

zconfig(3X)