1 /* 2 * Written by Eivind Eklund <eivind@yes.no> 3 * for Yes Interactive 4 * 5 * Copyright (C) 1998, Yes Interactive. All rights reserved. 6 * 7 * Redistribution and use in any form is permitted. Redistribution in 8 * source form should include the above copyright and this set of 9 * conditions, because large sections american law seems to have been 10 * created by a bunch of jerks on drugs that are now illegal, forcing 11 * me to include this copyright-stuff instead of placing this in the 12 * public domain. The name of of 'Yes Interactive' or 'Eivind Eklund' 13 * may not be used to endorse or promote products derived from this 14 * software without specific prior written permission. 15 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED 17 * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. 18 * 19 * $Id: physical.h,v 1.13 1999/06/05 21:35:52 brian Exp $ 20 * 21 */ 22 23 struct datalink; 24 struct bundle; 25 struct iovec; 26 struct physical; 27 struct bundle; 28 struct ccp; 29 struct cmdargs; 30 31 /* Device types */ 32 #define I4B_DEVICE 1 33 #define TTY_DEVICE 2 34 #define TCP_DEVICE 3 35 #define UDP_DEVICE 4 36 #define EXEC_DEVICE 5 37 38 /* Returns from awaitcarrier() */ 39 #define CARRIER_PENDING 1 40 #define CARRIER_OK 2 41 #define CARRIER_LOST 3 42 43 struct device { 44 int type; 45 const char *name; 46 47 int (*awaitcarrier)(struct physical *); 48 int (*raw)(struct physical *); 49 void (*offline)(struct physical *); 50 void (*cooked)(struct physical *); 51 void (*stoptimer)(struct physical *); 52 void (*destroy)(struct physical *); 53 ssize_t (*read)(struct physical *, void *, size_t); 54 ssize_t (*write)(struct physical *, const void *, size_t); 55 void (*device2iov)(struct device *, struct iovec *, int *, int, pid_t); 56 int (*speed)(struct physical *); 57 const char *(*openinfo)(struct physical *); 58 }; 59 60 struct physical { 61 struct link link; 62 struct descriptor desc; 63 int type; /* What sort of PHYS_* link are we ? */ 64 struct async async; /* Our async state */ 65 struct hdlc hdlc; /* Our hdlc state */ 66 int fd; /* File descriptor for this device */ 67 struct mbuf *out; /* mbuf that suffered a short write */ 68 int connect_count; 69 struct datalink *dl; /* my owner */ 70 71 struct { 72 u_char buf[MAX_MRU]; /* Our input data buffer */ 73 size_t sz; 74 } input; 75 76 struct { 77 char full[DEVICE_LEN]; /* Our current device name */ 78 char *base; 79 } name; 80 81 unsigned Utmp : 1; /* Are we in utmp ? (move to ttydevice ?) */ 82 pid_t session_owner; /* HUP this when closing the link */ 83 84 struct device *handler; /* device specific handler */ 85 86 struct { 87 unsigned rts_cts : 1; /* Is rts/cts enabled ? */ 88 unsigned parity; /* What parity is enabled? (tty flags) */ 89 unsigned speed; /* tty speed */ 90 91 char devlist[LINE_LEN]; /* NUL separated list of devices */ 92 int ndev; /* number of devices in list */ 93 struct { 94 unsigned required : 1; /* Is cd *REQUIRED* on this device */ 95 int delay; /* Wait this many seconds after login script */ 96 } cd; 97 } cfg; 98 }; 99 100 #define field2phys(fp, name) \ 101 ((struct physical *)((char *)fp - (int)(&((struct physical *)0)->name))) 102 103 #define link2physical(l) \ 104 ((l)->type == PHYSICAL_LINK ? field2phys(l, link) : NULL) 105 106 #define descriptor2physical(d) \ 107 ((d)->type == PHYSICAL_DESCRIPTOR ? field2phys(d, desc) : NULL) 108 109 #define PHYSICAL_NOFORCE 1 110 #define PHYSICAL_FORCE_ASYNC 2 111 #define PHYSICAL_FORCE_SYNC 3 112 113 extern struct physical *physical_Create(struct datalink *, int); 114 extern int physical_Open(struct physical *, struct bundle *); 115 extern int physical_Raw(struct physical *); 116 extern int physical_GetSpeed(struct physical *); 117 extern int physical_SetSpeed(struct physical *, int); 118 extern int physical_SetParity(struct physical *, const char *); 119 extern int physical_SetRtsCts(struct physical *, int); 120 extern void physical_SetSync(struct physical *); 121 extern int physical_ShowStatus(struct cmdargs const *); 122 extern void physical_Offline(struct physical *); 123 extern void physical_Close(struct physical *); 124 extern void physical_Destroy(struct physical *); 125 extern struct physical *iov2physical(struct datalink *, struct iovec *, int *, 126 int, int); 127 extern int physical2iov(struct physical *, struct iovec *, int *, int, pid_t); 128 extern void physical_ChangedPid(struct physical *, pid_t); 129 130 extern int physical_IsSync(struct physical *); 131 extern const char *physical_GetDevice(struct physical *); 132 extern void physical_SetDeviceList(struct physical *, int, const char *const *); 133 extern void physical_SetDevice(struct physical *, const char *); 134 135 extern ssize_t physical_Read(struct physical *, void *, size_t); 136 extern ssize_t physical_Write(struct physical *, const void *, size_t); 137 extern int physical_doUpdateSet(struct descriptor *, fd_set *, fd_set *, 138 fd_set *, int *, int); 139 extern int physical_IsSet(struct descriptor *, const fd_set *); 140 extern void physical_Login(struct physical *, const char *); 141 extern int physical_RemoveFromSet(struct physical *, fd_set *, fd_set *, 142 fd_set *); 143 extern int physical_SetMode(struct physical *, int); 144 extern void physical_DeleteQueue(struct physical *); 145 extern void physical_SetupStack(struct physical *, const char *, int); 146 extern void physical_StopDeviceTimer(struct physical *); 147 extern int physical_MaxDeviceSize(void); 148 extern int physical_AwaitCarrier(struct physical *); 149