1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
21da177e4SLinus Torvalds /* atmdev.h - ATM device driver declarations and various related items */
31da177e4SLinus Torvalds #ifndef LINUX_ATMDEV_H
41da177e4SLinus Torvalds #define LINUX_ATMDEV_H
51da177e4SLinus Torvalds
61da177e4SLinus Torvalds
71da177e4SLinus Torvalds #include <linux/wait.h> /* wait_queue_head_t */
81da177e4SLinus Torvalds #include <linux/time.h> /* struct timeval */
91da177e4SLinus Torvalds #include <linux/net.h>
10187f1882SPaul Gortmaker #include <linux/bug.h>
111da177e4SLinus Torvalds #include <linux/skbuff.h> /* struct sk_buff */
121da177e4SLinus Torvalds #include <linux/uio.h>
131da177e4SLinus Torvalds #include <net/sock.h>
1460063497SArun Sharma #include <linux/atomic.h>
15458bc30cSReshetova, Elena #include <linux/refcount.h>
16607ca46eSDavid Howells #include <uapi/linux/atmdev.h>
171da177e4SLinus Torvalds
181da177e4SLinus Torvalds #ifdef CONFIG_PROC_FS
191da177e4SLinus Torvalds #include <linux/proc_fs.h>
201da177e4SLinus Torvalds
211da177e4SLinus Torvalds extern struct proc_dir_entry *atm_proc_root;
221da177e4SLinus Torvalds #endif
231da177e4SLinus Torvalds
248865c418SDavid Woodhouse #ifdef CONFIG_COMPAT
258865c418SDavid Woodhouse #include <linux/compat.h>
268865c418SDavid Woodhouse struct compat_atm_iobuf {
278865c418SDavid Woodhouse int length;
288865c418SDavid Woodhouse compat_uptr_t buffer;
298865c418SDavid Woodhouse };
308865c418SDavid Woodhouse #endif
311da177e4SLinus Torvalds
321da177e4SLinus Torvalds struct k_atm_aal_stats {
331da177e4SLinus Torvalds #define __HANDLE_ITEM(i) atomic_t i
341da177e4SLinus Torvalds __AAL_STAT_ITEMS
351da177e4SLinus Torvalds #undef __HANDLE_ITEM
361da177e4SLinus Torvalds };
371da177e4SLinus Torvalds
381da177e4SLinus Torvalds
391da177e4SLinus Torvalds struct k_atm_dev_stats {
401da177e4SLinus Torvalds struct k_atm_aal_stats aal0;
411da177e4SLinus Torvalds struct k_atm_aal_stats aal34;
421da177e4SLinus Torvalds struct k_atm_aal_stats aal5;
431da177e4SLinus Torvalds };
441da177e4SLinus Torvalds
45313162d0SPaul Gortmaker struct device;
461da177e4SLinus Torvalds
471da177e4SLinus Torvalds enum {
481da177e4SLinus Torvalds ATM_VF_ADDR, /* Address is in use. Set by anybody, cleared
491da177e4SLinus Torvalds by device driver. */
501da177e4SLinus Torvalds ATM_VF_READY, /* VC is ready to transfer data. Set by device
511da177e4SLinus Torvalds driver, cleared by anybody. */
521da177e4SLinus Torvalds ATM_VF_PARTIAL, /* resources are bound to PVC (partial PVC
531da177e4SLinus Torvalds setup), controlled by socket layer */
541da177e4SLinus Torvalds ATM_VF_REGIS, /* registered with demon, controlled by SVC
551da177e4SLinus Torvalds socket layer */
561da177e4SLinus Torvalds ATM_VF_BOUND, /* local SAP is set, controlled by SVC socket
571da177e4SLinus Torvalds layer */
581da177e4SLinus Torvalds ATM_VF_RELEASED, /* demon has indicated/requested release,
591da177e4SLinus Torvalds controlled by SVC socket layer */
601da177e4SLinus Torvalds ATM_VF_HASQOS, /* QOS parameters have been set */
611da177e4SLinus Torvalds ATM_VF_LISTEN, /* socket is used for listening */
621da177e4SLinus Torvalds ATM_VF_META, /* SVC socket isn't used for normal data
631da177e4SLinus Torvalds traffic and doesn't depend on signaling
641da177e4SLinus Torvalds to be available */
651da177e4SLinus Torvalds ATM_VF_SESSION, /* VCC is p2mp session control descriptor */
661da177e4SLinus Torvalds ATM_VF_HASSAP, /* SAP has been set */
671da177e4SLinus Torvalds ATM_VF_CLOSE, /* asynchronous close - treat like VF_RELEASED*/
681da177e4SLinus Torvalds ATM_VF_WAITING, /* waiting for reply from sigd */
691da177e4SLinus Torvalds ATM_VF_IS_CLIP, /* in use by CLIP protocol */
701da177e4SLinus Torvalds };
711da177e4SLinus Torvalds
721da177e4SLinus Torvalds
731da177e4SLinus Torvalds #define ATM_VF2VS(flags) \
741da177e4SLinus Torvalds (test_bit(ATM_VF_READY,&(flags)) ? ATM_VS_CONNECTED : \
751da177e4SLinus Torvalds test_bit(ATM_VF_RELEASED,&(flags)) ? ATM_VS_CLOSING : \
761da177e4SLinus Torvalds test_bit(ATM_VF_LISTEN,&(flags)) ? ATM_VS_LISTEN : \
771da177e4SLinus Torvalds test_bit(ATM_VF_REGIS,&(flags)) ? ATM_VS_INUSE : \
781da177e4SLinus Torvalds test_bit(ATM_VF_BOUND,&(flags)) ? ATM_VS_BOUND : ATM_VS_IDLE)
791da177e4SLinus Torvalds
801da177e4SLinus Torvalds
811da177e4SLinus Torvalds enum {
8264bf69ddSStanislaw Gruszka ATM_DF_REMOVED, /* device was removed from atm_devs list */
831da177e4SLinus Torvalds };
841da177e4SLinus Torvalds
851da177e4SLinus Torvalds
861da177e4SLinus Torvalds #define ATM_PHY_SIG_LOST 0 /* no carrier/light */
871da177e4SLinus Torvalds #define ATM_PHY_SIG_UNKNOWN 1 /* carrier/light status is unknown */
881da177e4SLinus Torvalds #define ATM_PHY_SIG_FOUND 2 /* carrier/light okay */
891da177e4SLinus Torvalds
901da177e4SLinus Torvalds #define ATM_ATMOPT_CLP 1 /* set CLP bit */
911da177e4SLinus Torvalds
921da177e4SLinus Torvalds struct atm_vcc {
931da177e4SLinus Torvalds /* struct sock has to be the first member of atm_vcc */
941da177e4SLinus Torvalds struct sock sk;
951da177e4SLinus Torvalds unsigned long flags; /* VCC flags (ATM_VF_*) */
961da177e4SLinus Torvalds short vpi; /* VPI and VCI (types must be equal */
971da177e4SLinus Torvalds /* with sockaddr) */
981da177e4SLinus Torvalds int vci;
991da177e4SLinus Torvalds unsigned long aal_options; /* AAL layer options */
1001da177e4SLinus Torvalds unsigned long atm_options; /* ATM layer options */
1011da177e4SLinus Torvalds struct atm_dev *dev; /* device back pointer */
1021da177e4SLinus Torvalds struct atm_qos qos; /* QOS */
1031da177e4SLinus Torvalds struct atm_sap sap; /* SAP */
104c971f08cSDavid Woodhouse void (*release_cb)(struct atm_vcc *vcc); /* release_sock callback */
1051da177e4SLinus Torvalds void (*push)(struct atm_vcc *vcc,struct sk_buff *skb);
1061da177e4SLinus Torvalds void (*pop)(struct atm_vcc *vcc,struct sk_buff *skb); /* optional */
1071da177e4SLinus Torvalds int (*push_oam)(struct atm_vcc *vcc,void *cell);
1081da177e4SLinus Torvalds int (*send)(struct atm_vcc *vcc,struct sk_buff *skb);
1091da177e4SLinus Torvalds void *dev_data; /* per-device data */
1101da177e4SLinus Torvalds void *proto_data; /* per-protocol data */
1111da177e4SLinus Torvalds struct k_atm_aal_stats *stats; /* pointer to AAL stats group */
112ec809bd8SKrzysztof Mazur struct module *owner; /* owner of ->push function */
1131da177e4SLinus Torvalds /* SVC part --- may move later ------------------------------------- */
1141da177e4SLinus Torvalds short itf; /* interface number */
1151da177e4SLinus Torvalds struct sockaddr_atmsvc local;
1161da177e4SLinus Torvalds struct sockaddr_atmsvc remote;
1171da177e4SLinus Torvalds /* Multipoint part ------------------------------------------------- */
1181da177e4SLinus Torvalds struct atm_vcc *session; /* session VCC descriptor */
1191da177e4SLinus Torvalds /* Other stuff ----------------------------------------------------- */
1201da177e4SLinus Torvalds void *user_back; /* user backlink - not touched by */
1211da177e4SLinus Torvalds /* native ATM stack. Currently used */
1221da177e4SLinus Torvalds /* by CLIP and sch_atm. */
1231da177e4SLinus Torvalds };
1241da177e4SLinus Torvalds
atm_sk(struct sock * sk)1251da177e4SLinus Torvalds static inline struct atm_vcc *atm_sk(struct sock *sk)
1261da177e4SLinus Torvalds {
1271da177e4SLinus Torvalds return (struct atm_vcc *)sk;
1281da177e4SLinus Torvalds }
1291da177e4SLinus Torvalds
ATM_SD(struct socket * sock)1301da177e4SLinus Torvalds static inline struct atm_vcc *ATM_SD(struct socket *sock)
1311da177e4SLinus Torvalds {
1321da177e4SLinus Torvalds return atm_sk(sock->sk);
1331da177e4SLinus Torvalds }
1341da177e4SLinus Torvalds
sk_atm(struct atm_vcc * vcc)1351da177e4SLinus Torvalds static inline struct sock *sk_atm(struct atm_vcc *vcc)
1361da177e4SLinus Torvalds {
1371da177e4SLinus Torvalds return (struct sock *)vcc;
1381da177e4SLinus Torvalds }
1391da177e4SLinus Torvalds
1401da177e4SLinus Torvalds struct atm_dev_addr {
1411da177e4SLinus Torvalds struct sockaddr_atmsvc addr; /* ATM address */
1421da177e4SLinus Torvalds struct list_head entry; /* next address */
1431da177e4SLinus Torvalds };
1441da177e4SLinus Torvalds
1450f21ba7cSEric Kinzie enum atm_addr_type_t { ATM_ADDR_LOCAL, ATM_ADDR_LECS };
1460f21ba7cSEric Kinzie
1471da177e4SLinus Torvalds struct atm_dev {
1481da177e4SLinus Torvalds const struct atmdev_ops *ops; /* device operations; NULL if unused */
1491da177e4SLinus Torvalds const struct atmphy_ops *phy; /* PHY operations, may be undefined */
1501da177e4SLinus Torvalds /* (NULL) */
1511da177e4SLinus Torvalds const char *type; /* device type name */
1521da177e4SLinus Torvalds int number; /* device index */
1531da177e4SLinus Torvalds void *dev_data; /* per-device data */
154*1019d792STong Zhang void *phy_data; /* private PHY data */
1551da177e4SLinus Torvalds unsigned long flags; /* device flags (ATM_DF_*) */
1561da177e4SLinus Torvalds struct list_head local; /* local ATM addresses */
1570f21ba7cSEric Kinzie struct list_head lecs; /* LECS ATM addresses learned via ILMI */
1581da177e4SLinus Torvalds unsigned char esi[ESI_LEN]; /* ESI ("MAC" addr) */
1591da177e4SLinus Torvalds struct atm_cirange ci_range; /* VPI/VCI range */
1601da177e4SLinus Torvalds struct k_atm_dev_stats stats; /* statistics */
1611da177e4SLinus Torvalds char signal; /* signal status (ATM_PHY_SIG_*) */
1621da177e4SLinus Torvalds int link_rate; /* link rate (default: OC3) */
163458bc30cSReshetova, Elena refcount_t refcnt; /* reference count */
1641da177e4SLinus Torvalds spinlock_t lock; /* protect internal members */
1651da177e4SLinus Torvalds #ifdef CONFIG_PROC_FS
1661da177e4SLinus Torvalds struct proc_dir_entry *proc_entry; /* proc entry */
1671da177e4SLinus Torvalds char *proc_name; /* proc entry name */
1681da177e4SLinus Torvalds #endif
169ef39592fSKay Sievers struct device class_dev; /* sysfs device */
1701da177e4SLinus Torvalds struct list_head dev_list; /* linkage */
1711da177e4SLinus Torvalds };
1721da177e4SLinus Torvalds
1731da177e4SLinus Torvalds
1741da177e4SLinus Torvalds /* OF: send_Oam Flags */
1751da177e4SLinus Torvalds
1761da177e4SLinus Torvalds #define ATM_OF_IMMED 1 /* Attempt immediate delivery */
1771da177e4SLinus Torvalds #define ATM_OF_INRATE 2 /* Attempt in-rate delivery */
1781da177e4SLinus Torvalds
1791da177e4SLinus Torvalds struct atmdev_ops { /* only send is required */
1801da177e4SLinus Torvalds void (*dev_close)(struct atm_dev *dev);
1811da177e4SLinus Torvalds int (*open)(struct atm_vcc *vcc);
1821da177e4SLinus Torvalds void (*close)(struct atm_vcc *vcc);
1831da177e4SLinus Torvalds int (*ioctl)(struct atm_dev *dev,unsigned int cmd,void __user *arg);
1848865c418SDavid Woodhouse #ifdef CONFIG_COMPAT
1858865c418SDavid Woodhouse int (*compat_ioctl)(struct atm_dev *dev,unsigned int cmd,
1868865c418SDavid Woodhouse void __user *arg);
1878865c418SDavid Woodhouse #endif
1881da177e4SLinus Torvalds int (*send)(struct atm_vcc *vcc,struct sk_buff *skb);
189f2bcc2faSSebastian Andrzej Siewior int (*send_bh)(struct atm_vcc *vcc, struct sk_buff *skb);
1901da177e4SLinus Torvalds int (*send_oam)(struct atm_vcc *vcc,void *cell,int flags);
1911da177e4SLinus Torvalds void (*phy_put)(struct atm_dev *dev,unsigned char value,
1921da177e4SLinus Torvalds unsigned long addr);
1931da177e4SLinus Torvalds unsigned char (*phy_get)(struct atm_dev *dev,unsigned long addr);
1941da177e4SLinus Torvalds int (*change_qos)(struct atm_vcc *vcc,struct atm_qos *qos,int flags);
1951da177e4SLinus Torvalds int (*proc_read)(struct atm_dev *dev,loff_t *pos,char *page);
1961da177e4SLinus Torvalds struct module *owner;
1971da177e4SLinus Torvalds };
1981da177e4SLinus Torvalds
1991da177e4SLinus Torvalds struct atmphy_ops {
2001da177e4SLinus Torvalds int (*start)(struct atm_dev *dev);
2011da177e4SLinus Torvalds int (*ioctl)(struct atm_dev *dev,unsigned int cmd,void __user *arg);
2021da177e4SLinus Torvalds void (*interrupt)(struct atm_dev *dev);
2031da177e4SLinus Torvalds int (*stop)(struct atm_dev *dev);
2041da177e4SLinus Torvalds };
2051da177e4SLinus Torvalds
2061da177e4SLinus Torvalds struct atm_skb_data {
2071da177e4SLinus Torvalds struct atm_vcc *vcc; /* ATM VCC */
2081da177e4SLinus Torvalds unsigned long atm_options; /* ATM layer options */
2099bbe60a6SDavid Woodhouse unsigned int acct_truesize; /* truesize accounted to vcc */
210d0a0bbe7STong Zhang } __packed;
2111da177e4SLinus Torvalds
2121da177e4SLinus Torvalds #define VCC_HTABLE_SIZE 32
2131da177e4SLinus Torvalds
2141da177e4SLinus Torvalds extern struct hlist_head vcc_hash[VCC_HTABLE_SIZE];
2151da177e4SLinus Torvalds extern rwlock_t vcc_sklist_lock;
2161da177e4SLinus Torvalds
2171da177e4SLinus Torvalds #define ATM_SKB(skb) (((struct atm_skb_data *) (skb)->cb))
2181da177e4SLinus Torvalds
219d9ca676bSDan Williams struct atm_dev *atm_dev_register(const char *type, struct device *parent,
220d9ca676bSDan Williams const struct atmdev_ops *ops,
221d9ca676bSDan Williams int number, /* -1 == pick first available */
222d9ca676bSDan Williams unsigned long *flags);
2231da177e4SLinus Torvalds struct atm_dev *atm_dev_lookup(int number);
2241da177e4SLinus Torvalds void atm_dev_deregister(struct atm_dev *dev);
2257313bb8fSKarl Hiramoto
2267313bb8fSKarl Hiramoto /* atm_dev_signal_change
2277313bb8fSKarl Hiramoto *
2287313bb8fSKarl Hiramoto * Propagate lower layer signal change in atm_dev->signal to netdevice.
2297313bb8fSKarl Hiramoto * The event will be sent via a notifier call chain.
2307313bb8fSKarl Hiramoto */
2317313bb8fSKarl Hiramoto void atm_dev_signal_change(struct atm_dev *dev, char signal);
2327313bb8fSKarl Hiramoto
2331da177e4SLinus Torvalds void vcc_insert_socket(struct sock *sk);
2341da177e4SLinus Torvalds
235c031235bSPhilip A. Prindeville void atm_dev_release_vccs(struct atm_dev *dev);
2361da177e4SLinus Torvalds
atm_account_tx(struct atm_vcc * vcc,struct sk_buff * skb)2379bbe60a6SDavid Woodhouse static inline void atm_account_tx(struct atm_vcc *vcc, struct sk_buff *skb)
2389bbe60a6SDavid Woodhouse {
2399bbe60a6SDavid Woodhouse /*
2409bbe60a6SDavid Woodhouse * Because ATM skbs may not belong to a sock (and we don't
2419bbe60a6SDavid Woodhouse * necessarily want to), skb->truesize may be adjusted,
2429bbe60a6SDavid Woodhouse * escaping the hack in pskb_expand_head() which avoids
2439bbe60a6SDavid Woodhouse * doing so for some cases. So stash the value of truesize
2449bbe60a6SDavid Woodhouse * at the time we accounted it, and atm_pop_raw() can use
2459bbe60a6SDavid Woodhouse * that value later, in case it changes.
2469bbe60a6SDavid Woodhouse */
2479bbe60a6SDavid Woodhouse refcount_add(skb->truesize, &sk_atm(vcc)->sk_wmem_alloc);
2489bbe60a6SDavid Woodhouse ATM_SKB(skb)->acct_truesize = skb->truesize;
2499bbe60a6SDavid Woodhouse ATM_SKB(skb)->atm_options = vcc->atm_options;
2509bbe60a6SDavid Woodhouse }
2511da177e4SLinus Torvalds
atm_force_charge(struct atm_vcc * vcc,int truesize)2521da177e4SLinus Torvalds static inline void atm_force_charge(struct atm_vcc *vcc,int truesize)
2531da177e4SLinus Torvalds {
2541da177e4SLinus Torvalds atomic_add(truesize, &sk_atm(vcc)->sk_rmem_alloc);
2551da177e4SLinus Torvalds }
2561da177e4SLinus Torvalds
2571da177e4SLinus Torvalds
atm_return(struct atm_vcc * vcc,int truesize)2581da177e4SLinus Torvalds static inline void atm_return(struct atm_vcc *vcc,int truesize)
2591da177e4SLinus Torvalds {
2601da177e4SLinus Torvalds atomic_sub(truesize, &sk_atm(vcc)->sk_rmem_alloc);
2611da177e4SLinus Torvalds }
2621da177e4SLinus Torvalds
2631da177e4SLinus Torvalds
atm_may_send(struct atm_vcc * vcc,unsigned int size)2641da177e4SLinus Torvalds static inline int atm_may_send(struct atm_vcc *vcc,unsigned int size)
2651da177e4SLinus Torvalds {
26614afee4bSReshetova, Elena return (size + refcount_read(&sk_atm(vcc)->sk_wmem_alloc)) <
2671da177e4SLinus Torvalds sk_atm(vcc)->sk_sndbuf;
2681da177e4SLinus Torvalds }
2691da177e4SLinus Torvalds
2701da177e4SLinus Torvalds
atm_dev_hold(struct atm_dev * dev)2711da177e4SLinus Torvalds static inline void atm_dev_hold(struct atm_dev *dev)
2721da177e4SLinus Torvalds {
273458bc30cSReshetova, Elena refcount_inc(&dev->refcnt);
2741da177e4SLinus Torvalds }
2751da177e4SLinus Torvalds
2761da177e4SLinus Torvalds
atm_dev_put(struct atm_dev * dev)2771da177e4SLinus Torvalds static inline void atm_dev_put(struct atm_dev *dev)
2781da177e4SLinus Torvalds {
279458bc30cSReshetova, Elena if (refcount_dec_and_test(&dev->refcnt)) {
28064bf69ddSStanislaw Gruszka BUG_ON(!test_bit(ATM_DF_REMOVED, &dev->flags));
28164bf69ddSStanislaw Gruszka if (dev->ops->dev_close)
28264bf69ddSStanislaw Gruszka dev->ops->dev_close(dev);
283ef39592fSKay Sievers put_device(&dev->class_dev);
28464bf69ddSStanislaw Gruszka }
2851da177e4SLinus Torvalds }
2861da177e4SLinus Torvalds
2871da177e4SLinus Torvalds
2881da177e4SLinus Torvalds int atm_charge(struct atm_vcc *vcc,int truesize);
2891da177e4SLinus Torvalds struct sk_buff *atm_alloc_charge(struct atm_vcc *vcc,int pdu_size,
290dd0fc66fSAl Viro gfp_t gfp_flags);
291c219750bSMitchell Blank Jr int atm_pcr_goal(const struct atm_trafprm *tp);
2921da177e4SLinus Torvalds
2931da177e4SLinus Torvalds void vcc_release_async(struct atm_vcc *vcc, int reply);
2941da177e4SLinus Torvalds
2951da177e4SLinus Torvalds struct atm_ioctl {
2961da177e4SLinus Torvalds struct module *owner;
2971da177e4SLinus Torvalds /* A module reference is kept if appropriate over this call.
2981da177e4SLinus Torvalds * Return -ENOIOCTLCMD if you don't handle it. */
2991da177e4SLinus Torvalds int (*ioctl)(struct socket *, unsigned int cmd, unsigned long arg);
3001da177e4SLinus Torvalds struct list_head list;
3011da177e4SLinus Torvalds };
3021da177e4SLinus Torvalds
3031da177e4SLinus Torvalds /**
3041da177e4SLinus Torvalds * register_atm_ioctl - register handler for ioctl operations
3051da177e4SLinus Torvalds *
3061da177e4SLinus Torvalds * Special (non-device) handlers of ioctl's should
3071da177e4SLinus Torvalds * register here. If you're a normal device, you should
3081da177e4SLinus Torvalds * set .ioctl in your atmdev_ops instead.
3091da177e4SLinus Torvalds */
3101da177e4SLinus Torvalds void register_atm_ioctl(struct atm_ioctl *);
3111da177e4SLinus Torvalds
3121da177e4SLinus Torvalds /**
3131da177e4SLinus Torvalds * deregister_atm_ioctl - remove the ioctl handler
3141da177e4SLinus Torvalds */
3151da177e4SLinus Torvalds void deregister_atm_ioctl(struct atm_ioctl *);
3161da177e4SLinus Torvalds
3177313bb8fSKarl Hiramoto
3187313bb8fSKarl Hiramoto /* register_atmdevice_notifier - register atm_dev notify events
3197313bb8fSKarl Hiramoto *
3207313bb8fSKarl Hiramoto * Clients like br2684 will register notify events
3217313bb8fSKarl Hiramoto * Currently we notify of signal found/lost
3227313bb8fSKarl Hiramoto */
3237313bb8fSKarl Hiramoto int register_atmdevice_notifier(struct notifier_block *nb);
3247313bb8fSKarl Hiramoto void unregister_atmdevice_notifier(struct notifier_block *nb);
3257313bb8fSKarl Hiramoto
3261da177e4SLinus Torvalds #endif
327