[bpt/emacs.git] / src / hftctl.c

/* IBM has disclaimed copyright on this module.  */

/***************************************************************/
/*                                                             */
/* Function: hftctl                                            */
/*                                                             */
/* Syntax:                                                     */
/*    #include <sys/ioctl.h>                                   */
/*    #include <sys/hft.h>                                     */
/*                                                             */
/*    int hftctl(fildes, request, arg )                        */
/*    int fildes, request;                                     */
/*    char *arg;                                               */
/*                                                             */
/* Description:                                                */
/*                                                             */
/*    Does the following:                                      */
/*      1. determines if fildes is pty                         */
/*         does normal ioctl it is not                         */
/*      2. places fildes into raw mode                         */
/*      3. converts ioctl arguments to datastream              */
/*      4. waits for 2 secs for acknowledgement before         */
/*         timimg out.                                         */
/*      5. places response in callers buffer ( just like       */
/*         ioctl.                                              */
/*      6. returns fildes to its original mode                 */
/*                                                             */
/*    User of this program should review steps 1,4, and 3.     */
/*    hftctl makes no check on the request type. It must be    */
/*    a HFT ioctl that is supported remotely.                  */
/*    This program will use the SIGALRM and alarm(2).  Any     */
/*    Previous alarms are lost.                                */
/*                                                             */
/*    Users of this program are free to modify it any way      */
/*    they want.                                               */
/*                                                             */
/* Return Value:                                               */
/*                                                             */
/*    If ioctl fails, a value of -1 is returned and errno      */
/*    is set to indicate the error.                            */
/*                                                             */
/***************************************************************/


#include <stdio.h>
#include <fcntl.h>
#include <errno.h>
#include <setjmp.h>
#include <sys/ioctl.h>
#include <sys/signal.h>
#include <sys/devinfo.h>
#include <termios.h>
#include <termio.h>
#include <sys/hft.h>
#include <sys/uio.h>
#include <sys/tty.h>
/* #include <sys/pty.h> */
#define REMOTE 0x01

#undef ioctl
static char     SCCSid[] = "com/gnuemacs/src,3.1,9021-90/05/03-5/3/90";

/*************** LOCAL DEFINES **********************************/

typedef int    (*FUNC)();     /* pointer to a function        */

#define QDEV   ((HFQPDEVCH<<8)|HFQPDEVCL)
#define QLOC   ((HFQLOCCH<<8)|HFQLOCCL)
#define QPS    ((HFQPRESCH<<8)|HFQPRESCL)

#ifndef TCGETS 
#define TCGETS TCGETA
#endif
#ifndef TCSETS
#define TCSETS TCSETA
#endif

/*************** EXTERNAL / GLOBAL DATA AREA ********************/

static int              hfqry();
static int              hfskbd();
       char            *xmalloc();

extern int              errno;
static jmp_buf          hftenv;
static int              is_ack_vtd;
static FUNC             sav_alrm;
static struct hfctlreq  req =
			{ 0x1b,'[','x',0,0,0,21,HFCTLREQCH,HFCTLREQCL};
static struct hfctlack  ACK =
			{ 0x1b,'[','x',0,0,0,21,HFCTLACKCH,HFCTLACKCL};

       /* FUNC             signal(); */

/*************** LOCAL MACROS ***********************************/

#define HFTYPE(p)   ((p->hf_typehi<<8)|(p->hf_typelo))

#define BYTE4(p)    ((p)[0]<<24 | (p)[1]<<16 | (p)[2]<<8 | (p)[3])

					/* read a buffer        */
#define RD_BUF(f,p,l) \
        while ((l)) \
          if ((j = read((f),(p),(l))) < 0) \
             if (errno != EINTR) return (-1); \
             else continue; \
          else { (l) -= j; (p) += j; }

/*************** function prototypes ***************************/
#ifdef __STDC__
static GT_ACK (int fd, int req, char *buf);
static WR_REQ (int fd, int request, int cmdlen, char *cmd, int resplen);
static hft_alrm(int sig);
#else
static GT_ACK ();
static WR_REQ ();
static hft_alrm ();
#endif

/*************** HFTCTL FUNCTION *******************************/

hftctl (fd, request, arg)
     int     fd;
     int     request;
     union {
       struct hfintro *intro;
       struct hfquery *query;
       char           *c;
     } arg;
{

  int             i;
  int             fd_flag;	/* fcntl flags          */
  register union {
    struct hfintro         *cmd; /* p.cmd - intro des.   */
    struct hfqphdevc       *ph;	/* p.ph  - physical dev.*/
    char            *c;		/* p.c   - char ptr     */
  }               p;		/* general pointer      */
  int             pty_new;	/* pty modes            */
  int             pty_old;
  int             retcode;
  struct termios   term_new;	/* terminal attributes  */
  struct termios   term_old;
  struct devinfo	devInfo; /* defined in sys/devinfo.h */


  if (ioctl (fd, IOCINFO, &devInfo) == -1) return(-1);

  if (devInfo.devtype != DD_PSEU) /* is it a pty? */
    return (ioctl(fd, request, arg)); /* no, do IOCTL */

  /******* START PTY **************/
  /**  Pty found, possible HFT    */
  /** set new file des as raw     */
  /** as you can.                 */
  /********************************/

  /* Get current state of file    */
  /* descriptor & save            */
  if ((fd_flag = fcntl (fd, F_GETFL, 0)) == -1) return (-1);
  if (ioctl (fd, TCGETS, &term_old) == -1) return (-1);
  /* set terminal attr to raw     */
  /* and to delay on read         */
  pty_new = pty_old | REMOTE;
  memcpy (&term_new, &term_old, sizeof (term_new));
  term_new.c_iflag = 0;
  term_new.c_oflag = 0;
  term_new.c_lflag = 0;
  /* term_new.c_line  = 0; */
  for (i = 1; i <= 5; i++)
    term_new.c_cc[i] = 0;
  term_new.c_cc[0] = -1;
  ioctl (fd, TCSETS, &term_new);
  if (fcntl (fd, F_SETFL, fd_flag & ~O_NDELAY) == -1)
    return(-1);
  /* call spacific function       */
  if (request == HFSKBD)
    retcode = hfskbd (fd, request, arg.c);
  else				/* assume HFQUERY */
    retcode = hfqry (fd, request, arg.c);

  fcntl (fd, F_SETFL, fd_flag); /* reset terminal to original   */
  ioctl (fd, TCSETS, &term_old);


  return (retcode);             /* return error                 */
}

/*************** HFSKBD  FUNCTION ******************************/
static int
hfskbd (fd, request, arg)
        int     fd;
        int     request;
        struct hfbuf *arg;
{
  WR_REQ(fd, request, arg->hf_buflen, arg->hf_bufp,0);
  return (GT_ACK(fd, request, arg->hf_bufp));
}

/*************** HFQUERY FUNCTION ******************************/
static int
hfqry (fd, request, arg)
        int     fd;
        int     request;
        struct hfquery *arg;
{
  WR_REQ(fd, request, arg->hf_cmdlen, arg->hf_cmd, arg->hf_resplen);
  return (GT_ACK(fd, request, arg->hf_resp));
}


/*************** GT_ACK FUNCTION ******************************/
static int
GT_ACK (fd, req, buf)
        int     fd;
        int     req;
        char   *buf;
{
  struct hfctlack ack;
  int             i = sizeof (ack);
  int             j = 0;
  union {
    char            *c;
    struct hfctlack *ack;
  }               p;

  is_ack_vtd = 0;		/* flag no ACT VTD yet         */

  if (setjmp (hftenv))		/* set environment in case     */
    {				/* of time out                 */
      errno = ENODEV;		/* if time out, set errno      */
      return (-1);		/* flag error                  */
    }

  alarm(3);			/* time out in 3 secs          */
  sav_alrm = signal (SIGALRM, hft_alrm); /* prepare to catch time out   */

  p.ack = &ack;
  while (! is_ack_vtd)		/* do until valid ACK VTD      */
    {
      RD_BUF(fd, p.c, i);	/* read until a ACK VTD is fill*/

      if (! memcmp (&ack, &ACK, sizeof (HFINTROSZ)) /* the ACK intro &  */
	  && (ack.hf_request == req)) /* is it the response we want ?*/
	{			/* yes, ACK VTD found          */
	  is_ack_vtd = 1;	/* quickly, flag it            */
	  break;		/* get the %$%#@ out of here   */
	}

      p.ack = &ack;		/* no, then skip 1st           */
      ++p.c;			/* char and start over         */
      i = sizeof (ack) - 1;	/* one less ESC to cry over    */

      while ((*p.c != 0x1b) && i) /* scan for next ESC           */
	{ ++p.c; --i; }		/* if any                      */

      (i ? memcpy (&ack, p.c, i) : 0); /* if any left over, then move */
      p.ack = &ack;		/* ESC to front of ack struct  */
      p.c += i;			/* skip over whats been read   */
      i = sizeof (ack) - i;	/* set whats left to be read   */
    }				/***** TRY AGAIN               */

  alarm(0);			/* ACK VTD received, reset alrm*/
  signal (SIGALRM, sav_alrm);	/* reset signal                */

  if (i = ack.hf_arg_len)	/* any data following ?        */
    {				/* yes,                        */
      RD_BUF(fd,buf,i);		/* read until it is received   */
    }

  if (errno = ack.hf_retcode)	/* set errno based on returned */
    return (-1);		/* code, if 0, then no error   */
  else
    return (0);			/* if set, then error returned */
}

/*************** HFT_ALRM FUNCTION ******************************/
static int
hft_alrm (sig)                    /* Function hft_alrm - handle  */
        int sig;		/* alarm signal               */
{
  signal (SIGALRM, sav_alrm);	/* reset to previous          */

  if (is_ack_vtd)		/* has ack vtd arrived ?      */
    return(0);			/* yes, then continue         */
  else				/* no, then return with error */
    longjmp (hftenv, -1);

}

/*********************************************************************/
/***                                                               ***/
/***  NOTE: Both the HFCTLREQ and the arg structure should be      ***/
/***        sent in one io write operation.  If terminal           ***/
/***        emulators are in NODELAY mode then multiple writes     ***/
/***        may cause bogus information to be read by the emulator ***/
/***        depending on the timing.                               ***/
/***                                                               ***/
/*********************************************************************/

static int
WR_REQ (fd, request, cmdlen, cmd, resplen)
	int             fd;
	int             request;
	int             cmdlen;
	char           *cmd;
	int             resplen;
{
  struct {
    char            *c;
    struct hfctlreq *req;
  }              p;
  int            size;

  req.hf_request = request;
  req.hf_arg_len = cmdlen;
  req.hf_rsp_len = resplen;

  if (cmdlen)			/* if arg structure to pass    */
    {
      size = sizeof (struct hfctlreq) + cmdlen;
      if ((p.c = xmalloc(size)) == NULL) /* malloc one area            */
	return (-1);

      memcpy (p.c, &req, sizeof (req)); /* copy CTL REQ struct         */
      memcpy (p.c + sizeof (req), cmd, cmdlen); /* copy arg struct     */
    }
  else
    {
      p.req = &req;		/* otherwise use only CTL REQ  */
      size = sizeof (req);
    }

  /* write request to terminal   */
  if (write(fd,p.c,size) == -1) return (-1);
  if (p.req != &req)		/* free if allocated           */
    xfree (p.c);
  return (0);

}
Commit	Line	Data
b70021f4 MR	1	/* IBM has disclaimed copyright on this module. */
	2
	3	/***************************************************************/
	4	/* */
	5	/* Function: hftctl */
	6	/* */
	7	/* Syntax: */
	8	/* #include <sys/ioctl.h> */
	9	/* #include <sys/hft.h> */
	10	/* */
	11	/* int hftctl(fildes, request, arg ) */
265a9e55 JB	12	/* int fildes, request; */
265a9e55 JB	13	/* char arg; /
b70021f4 MR	14	/* */
	15	/* Description: */
	16	/* */
	17	/* Does the following: */
	18	/* 1. determines if fildes is pty */
	19	/* does normal ioctl it is not */
	20	/* 2. places fildes into raw mode */
	21	/* 3. converts ioctl arguments to datastream */
	22	/* 4. waits for 2 secs for acknowledgement before */
	23	/* timimg out. */
	24	/* 5. places response in callers buffer ( just like */
	25	/* ioctl. */
	26	/* 6. returns fildes to its original mode */
	27	/* */
	28	/* User of this program should review steps 1,4, and 3. */
	29	/* hftctl makes no check on the request type. It must be */
	30	/* a HFT ioctl that is supported remotely. */
	31	/* This program will use the SIGALRM and alarm(2). Any */
	32	/* Previous alarms are lost. */
	33	/* */
	34	/* Users of this program are free to modify it any way */
	35	/* they want. */
	36	/* */
	37	/* Return Value: */
	38	/* */
	39	/* If ioctl fails, a value of -1 is returned and errno */
	40	/* is set to indicate the error. */
	41	/* */
	42	/***************************************************************/
	43
	44
	45	#include <stdio.h>
	46	#include <fcntl.h>
	47	#include <errno.h>
	48	#include <setjmp.h>
	49	#include <sys/ioctl.h>
	50	#include <sys/signal.h>
	51	#include <sys/devinfo.h>
265a9e55	52	#include <termios.h>
b70021f4 MR	53	#include <termio.h>
b70021f4 MR	54	#include <sys/hft.h>
4e3a36cd	55	#include <sys/uio.h>
b70021f4 MR	56	#include <sys/tty.h>
	57	/* #include <sys/pty.h> */
	58	#define REMOTE 0x01
	59
	60	#undef ioctl
265a9e55	61	static char SCCSid[] = "com/gnuemacs/src,3.1,9021-90/05/03-5/3/90";
b70021f4 MR	62
	63	/************* LOCAL DEFINES ********************************/
	64
265a9e55	65	typedef int (FUNC)(); / pointer to a function */
b70021f4 MR	66
	67	#define QDEV ((HFQPDEVCH<<8)\|HFQPDEVCL)
	68	#define QLOC ((HFQLOCCH<<8)\|HFQLOCCL)
	69	#define QPS ((HFQPRESCH<<8)\|HFQPRESCL)
	70
265a9e55 JB	71	#ifndef TCGETS
	72	#define TCGETS TCGETA
	73	#endif
	74	#ifndef TCSETS
	75	#define TCSETS TCSETA
	76	#endif
	77
b70021f4 MR	78	/************* EXTERNAL / GLOBAL DATA AREA ******************/
b70021f4 MR	79
4e3a36cd JB	80	static int hfqry();
4e3a36cd JB	81	static int hfskbd();
9ac0d9e0	82	char *xmalloc();
b70021f4	83
265a9e55 JB	84	extern int errno;
	85	static jmp_buf hftenv;
	86	static int is_ack_vtd;
	87	static FUNC sav_alrm;
b70021f4 MR	88	static struct hfctlreq req =
	89	{ 0x1b,'[','x',0,0,0,21,HFCTLREQCH,HFCTLREQCL};
	90	static struct hfctlack ACK =
	91	{ 0x1b,'[','x',0,0,0,21,HFCTLACKCH,HFCTLACKCL};
	92
265a9e55	93	/* FUNC signal(); */
b70021f4 MR	94
	95	/************* LOCAL MACROS *********************************/
	96
	97	#define HFTYPE(p) ((p->hf_typehi<<8)\|(p->hf_typelo))
	98
265a9e55	99	#define BYTE4(p) ((p)[0]<<24 \| (p)[1]<<16 \| (p)[2]<<8 \| (p)[3])
b70021f4 MR	100
	101	/* read a buffer */
	102	#define RD_BUF(f,p,l) \
265a9e55 JB	103	while ((l)) \
	104	if ((j = read((f),(p),(l))) < 0) \
	105	if (errno != EINTR) return (-1); \
	106	else continue; \
	107	else { (l) -= j; (p) += j; }
	108
	109	/************* function prototypes *************************/
	110	#ifdef __STDC__
	111	static GT_ACK (int fd, int req, char *buf);
	112	static WR_REQ (int fd, int request, int cmdlen, char *cmd, int resplen);
	113	static hft_alrm(int sig);
	114	#else
	115	static GT_ACK ();
	116	static WR_REQ ();
	117	static hft_alrm ();
	118	#endif
b70021f4 MR	119
	120	/************* HFTCTL FUNCTION *****************************/
	121
265a9e55 JB	122	hftctl (fd, request, arg)
	123	int fd;
	124	int request;
	125	union {
	126	struct hfintro *intro;
	127	struct hfquery *query;
	128	char *c;
	129	} arg;
b70021f4 MR	130	{
b70021f4 MR	131
265a9e55 JB	132	int i;
	133	int fd_flag; /* fcntl flags */
	134	register union {
	135	struct hfintro cmd; / p.cmd - intro des. */
	136	struct hfqphdevc ph; / p.ph - physical dev.*/
	137	char c; / p.c - char ptr */
	138	} p; /* general pointer */
	139	int pty_new; /* pty modes */
	140	int pty_old;
	141	int retcode;
	142	struct termios term_new; /* terminal attributes */
	143	struct termios term_old;
	144	struct devinfo devInfo; /* defined in sys/devinfo.h */
	145
	146
	147	if (ioctl (fd, IOCINFO, &devInfo) == -1) return(-1);
	148
	149	if (devInfo.devtype != DD_PSEU) /* is it a pty? */
	150	return (ioctl(fd, request, arg)); /* no, do IOCTL */
	151
	152	/***** START PTY ************/
	153	/** Pty found, possible HFT */
	154	/** set new file des as raw */
	155	/** as you can. */
	156	/********************************/
	157
	158	/* Get current state of file */
	159	/* descriptor & save */
	160	if ((fd_flag = fcntl (fd, F_GETFL, 0)) == -1) return (-1);
	161	if (ioctl (fd, TCGETS, &term_old) == -1) return (-1);
	162	/* set terminal attr to raw */
	163	/* and to delay on read */
	164	pty_new = pty_old \| REMOTE;
	165	memcpy (&term_new, &term_old, sizeof (term_new));
	166	term_new.c_iflag = 0;
	167	term_new.c_oflag = 0;
	168	term_new.c_lflag = 0;
	169	/* term_new.c_line = 0; */
	170	for (i = 1; i <= 5; i++)
	171	term_new.c_cc[i] = 0;
	172	term_new.c_cc[0] = -1;
	173	ioctl (fd, TCSETS, &term_new);
	174	if (fcntl (fd, F_SETFL, fd_flag & ~O_NDELAY) == -1)
	175	return(-1);
	176	/* call spacific function */
	177	if (request == HFSKBD)
	178	retcode = hfskbd (fd, request, arg.c);
	179	else /* assume HFQUERY */
	180	retcode = hfqry (fd, request, arg.c);
	181
	182	fcntl (fd, F_SETFL, fd_flag); /* reset terminal to original */
	183	ioctl (fd, TCSETS, &term_old);
	184
	185
	186	return (retcode); /* return error */
b70021f4 MR	187	}
	188
	189	/************* HFSKBD FUNCTION ****************************/
265a9e55 JB	190	static int
	191	hfskbd (fd, request, arg)
	192	int fd;
	193	int request;
	194	struct hfbuf *arg;
b70021f4	195	{
265a9e55 JB	196	WR_REQ(fd, request, arg->hf_buflen, arg->hf_bufp,0);
265a9e55 JB	197	return (GT_ACK(fd, request, arg->hf_bufp));
b70021f4 MR	198	}
	199
	200	/************* HFQUERY FUNCTION ****************************/
265a9e55 JB	201	static int
	202	hfqry (fd, request, arg)
	203	int fd;
	204	int request;
	205	struct hfquery *arg;
b70021f4	206	{
265a9e55 JB	207	WR_REQ(fd, request, arg->hf_cmdlen, arg->hf_cmd, arg->hf_resplen);
265a9e55 JB	208	return (GT_ACK(fd, request, arg->hf_resp));
b70021f4 MR	209	}
	210
	211
	212	/************* GT_ACK FUNCTION ****************************/
265a9e55 JB	213	static int
	214	GT_ACK (fd, req, buf)
	215	int fd;
	216	int req;
	217	char *buf;
b70021f4	218	{
265a9e55 JB	219	struct hfctlack ack;
	220	int i = sizeof (ack);
	221	int j = 0;
	222	union {
	223	char *c;
	224	struct hfctlack *ack;
	225	} p;
	226
	227	is_ack_vtd = 0; /* flag no ACT VTD yet */
	228
	229	if (setjmp (hftenv)) /* set environment in case */
	230	{ /* of time out */
	231	errno = ENODEV; /* if time out, set errno */
	232	return (-1); /* flag error */
	233	}
	234
	235	alarm(3); /* time out in 3 secs */
	236	sav_alrm = signal (SIGALRM, hft_alrm); /* prepare to catch time out */
	237
	238	p.ack = &ack;
	239	while (! is_ack_vtd) /* do until valid ACK VTD */
	240	{
	241	RD_BUF(fd, p.c, i); /* read until a ACK VTD is fill*/
	242
	243	if (! memcmp (&ack, &ACK, sizeof (HFINTROSZ)) /* the ACK intro & */
	244	&& (ack.hf_request == req)) /* is it the response we want ?*/
	245	{ /* yes, ACK VTD found */
	246	is_ack_vtd = 1; /* quickly, flag it */
	247	break; /* get the %$%#@ out of here */
	248	}
	249
	250	p.ack = &ack; /* no, then skip 1st */
	251	++p.c; /* char and start over */
	252	i = sizeof (ack) - 1; /* one less ESC to cry over */
	253
	254	while ((p.c != 0x1b) && i) / scan for next ESC */
	255	{ ++p.c; --i; } /* if any */
	256
	257	(i ? memcpy (&ack, p.c, i) : 0); /* if any left over, then move */
	258	p.ack = &ack; /* ESC to front of ack struct */
	259	p.c += i; /* skip over whats been read */
	260	i = sizeof (ack) - i; /* set whats left to be read */
	261	} /***** TRY AGAIN */
	262
	263	alarm(0); /* ACK VTD received, reset alrm*/
	264	signal (SIGALRM, sav_alrm); /* reset signal */
	265
	266	if (i = ack.hf_arg_len) /* any data following ? */
	267	{ /* yes, */
	268	RD_BUF(fd,buf,i); /* read until it is received */
	269	}
	270
	271	if (errno = ack.hf_retcode) /* set errno based on returned */
	272	return (-1); /* code, if 0, then no error */
	273	else
	274	return (0); /* if set, then error returned */
b70021f4 MR	275	}
	276
	277	/************* HFT_ALRM FUNCTION ****************************/
265a9e55 JB	278	static int
	279	hft_alrm (sig) /* Function hft_alrm - handle */
	280	int sig; /* alarm signal */
b70021f4	281	{
265a9e55	282	signal (SIGALRM, sav_alrm); /* reset to previous */
b70021f4	283
265a9e55 JB	284	if (is_ack_vtd) /* has ack vtd arrived ? */
	285	return(0); /* yes, then continue */
	286	else /* no, then return with error */
	287	longjmp (hftenv, -1);
b70021f4 MR	288
	289	}
	290
	291	/*********************************************************************/
	292	/* */
	293	/* NOTE: Both the HFCTLREQ and the arg structure should be */
	294	/* sent in one io write operation. If terminal */
	295	/* emulators are in NODELAY mode then multiple writes */
	296	/* may cause bogus information to be read by the emulator */
	297	/* depending on the timing. */
	298	/* */
	299	/*********************************************************************/
	300
265a9e55 JB	301	static int
	302	WR_REQ (fd, request, cmdlen, cmd, resplen)
	303	int fd;
	304	int request;
	305	int cmdlen;
	306	char *cmd;
	307	int resplen;
b70021f4	308	{
265a9e55 JB	309	struct {
	310	char *c;
	311	struct hfctlreq *req;
	312	} p;
	313	int size;
	314
	315	req.hf_request = request;
	316	req.hf_arg_len = cmdlen;
	317	req.hf_rsp_len = resplen;
	318
	319	if (cmdlen) /* if arg structure to pass */
	320	{
	321	size = sizeof (struct hfctlreq) + cmdlen;
9ac0d9e0	322	if ((p.c = xmalloc(size)) == NULL) /* malloc one area */
265a9e55 JB	323	return (-1);
	324
	325	memcpy (p.c, &req, sizeof (req)); /* copy CTL REQ struct */
	326	memcpy (p.c + sizeof (req), cmd, cmdlen); /* copy arg struct */
	327	}
	328	else
	329	{
	330	p.req = &req; /* otherwise use only CTL REQ */
	331	size = sizeof (req);
	332	}
	333
	334	/* write request to terminal */
	335	if (write(fd,p.c,size) == -1) return (-1);
	336	if (p.req != &req) /* free if allocated */
9ac0d9e0	337	xfree (p.c);
265a9e55	338	return (0);
b70021f4 MR	339
b70021f4 MR	340	}