/* * Written by Eivind Eklund * for Yes Interactive * * Copyright (C) 1998, Yes Interactive. All rights reserved. * * Redistribution and use in any form is permitted. Redistribution in * source form should include the above copyright and this set of * conditions, because large sections american law seems to have been * created by a bunch of jerks on drugs that are now illegal, forcing * me to include this copyright-stuff instead of placing this in the * public domain. The name of of 'Yes Interactive' or 'Eivind Eklund' * may not be used to endorse or promote products derived from this * software without specific prior written permission. * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. * * $FreeBSD: src/usr.sbin/ppp/physical.h,v 1.20.2.3 2002/09/01 02:12:29 brian Exp $ * */ struct datalink; struct bundle; struct iovec; struct physical; struct bundle; struct ccp; struct cmdargs; /* Device types (don't use zero, it'll be confused with NULL in physical2iov */ #define I4B_DEVICE 1 #define TTY_DEVICE 2 #define TCP_DEVICE 3 #define UDP_DEVICE 4 #define ETHER_DEVICE 5 #define EXEC_DEVICE 6 #define ATM_DEVICE 7 #define NG_DEVICE 8 /* Returns from awaitcarrier() */ #define CARRIER_PENDING 1 #define CARRIER_OK 2 #define CARRIER_LOST 3 /* A cd ``necessity'' value */ #define CD_VARIABLE 0 #define CD_REQUIRED 1 #define CD_NOTREQUIRED 2 #define CD_DEFAULT 3 struct cd { unsigned necessity : 2; /* A CD_ value */ int delay; /* Wait this many seconds after login script */ }; struct device { int type; const char *name; u_short mtu; struct cd cd; int (*awaitcarrier)(struct physical *); int (*removefromset)(struct physical *, fd_set *, fd_set *, fd_set *); int (*raw)(struct physical *); void (*offline)(struct physical *); void (*cooked)(struct physical *); void (*setasyncparams)(struct physical *, u_int32_t, u_int32_t); void (*stoptimer)(struct physical *); void (*destroy)(struct physical *); ssize_t (*read)(struct physical *, void *, size_t); ssize_t (*write)(struct physical *, const void *, size_t); void (*device2iov)(struct device *, struct iovec *, int *, int, int *, int *); int (*speed)(struct physical *); const char *(*openinfo)(struct physical *); int (*slot)(struct physical *); }; struct physical { struct link link; struct fdescriptor desc; int type; /* What sort of PHYS_* link are we ? */ struct async async; /* Our async state */ struct hdlc hdlc; /* Our hdlc state */ int fd; /* File descriptor for this device */ struct mbuf *out; /* mbuf that suffered a short write */ int connect_count; struct datalink *dl; /* my owner */ struct { u_char buf[MAX_MRU]; /* Our input data buffer */ size_t sz; } input; struct { char full[DEVICE_LEN]; /* Our current device name */ char *base; } name; time_t Utmp; /* Are we in utmp ? */ pid_t session_owner; /* HUP this when closing the link */ struct device *handler; /* device specific handler */ struct { unsigned rts_cts : 1; /* Is rts/cts enabled ? */ unsigned parity; /* What parity is enabled? (tty flags) */ unsigned speed; /* tty speed */ char devlist[LINE_LEN]; /* NUL separated list of devices */ int ndev; /* number of devices in list */ struct cd cd; } cfg; }; #define field2phys(fp, name) \ ((struct physical *)((char *)fp - (uintptr_t)(&((struct physical *)0)->name))) #define link2physical(l) \ ((l)->type == PHYSICAL_LINK ? field2phys(l, link) : NULL) #define descriptor2physical(d) \ ((d)->type == PHYSICAL_DESCRIPTOR ? field2phys(d, desc) : NULL) #define PHYSICAL_NOFORCE 1 #define PHYSICAL_FORCE_ASYNC 2 #define PHYSICAL_FORCE_SYNC 3 #define PHYSICAL_FORCE_SYNCNOACF 4 extern struct physical *physical_Create(struct datalink *, int); extern int physical_Open(struct physical *); extern int physical_Raw(struct physical *); extern unsigned physical_GetSpeed(struct physical *); extern int physical_SetSpeed(struct physical *, unsigned); extern int physical_SetParity(struct physical *, const char *); extern int physical_SetRtsCts(struct physical *, int); extern void physical_SetSync(struct physical *); extern int physical_ShowStatus(struct cmdargs const *); extern void physical_Offline(struct physical *); extern void physical_Close(struct physical *); extern void physical_Destroy(struct physical *); extern struct physical *iov2physical(struct datalink *, struct iovec *, int *, int, int, int *, int *); extern int physical2iov(struct physical *, struct iovec *, int *, int, int *, int *); extern const char *physical_LockedDevice(struct physical *); extern void physical_ChangedPid(struct physical *, pid_t); extern int physical_IsSync(struct physical *); extern u_short physical_DeviceMTU(struct physical *); extern const char *physical_GetDevice(struct physical *); extern void physical_SetDeviceList(struct physical *, int, const char *const *); extern void physical_SetDevice(struct physical *, const char *); extern ssize_t physical_Read(struct physical *, void *, size_t); extern ssize_t physical_Write(struct physical *, const void *, size_t); extern int physical_doUpdateSet(struct fdescriptor *, fd_set *, fd_set *, fd_set *, int *, int); extern int physical_IsSet(struct fdescriptor *, const fd_set *); extern void physical_DescriptorRead(struct fdescriptor *, struct bundle *, const fd_set *); extern void physical_Login(struct physical *, const char *); extern int physical_RemoveFromSet(struct physical *, fd_set *, fd_set *, fd_set *); extern int physical_SetMode(struct physical *, int); extern void physical_DeleteQueue(struct physical *); extern void physical_SetupStack(struct physical *, const char *, int); extern void physical_StopDeviceTimer(struct physical *); extern unsigned physical_MaxDeviceSize(void); extern int physical_AwaitCarrier(struct physical *); extern void physical_SetDescriptor(struct physical *); extern void physical_SetAsyncParams(struct physical *, u_int32_t, u_int32_t); extern int physical_Slot(struct physical *);