3 * ===================================
4 * HARP | Host ATM Research Platform
5 * ===================================
8 * This Host ATM Research Platform ("HARP") file (the "Software") is
9 * made available by Network Computing Services, Inc. ("NetworkCS")
10 * "AS IS". NetworkCS does not provide maintenance, improvements or
11 * support of any kind.
13 * NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
14 * INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
15 * AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
16 * SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
17 * In no event shall NetworkCS be responsible for any damages, including
18 * but not limited to consequential damages, arising from or relating to
19 * any use of the Software or related support.
21 * Copyright 1994-1998 Network Computing Services, Inc.
23 * Copies of this Software may be made, however, the above copyright
24 * notice must be reproduced on all copies.
26 * @(#) $FreeBSD: src/sys/netatm/atm_if.c,v 1.5 1999/08/28 00:48:35 peter Exp $
27 * @(#) $DragonFly: src/sys/netproto/atm/atm_if.c,v 1.2 2003/06/17 04:28:49 dillon Exp $
34 * ATM interface management
38 #include <netatm/kern_include.h>
40 #if (defined(BSD) && (BSD < 199506))
47 static int atm_physif_ioctl __P((int, caddr_t, caddr_t));
48 #if (defined(BSD) && (BSD >= 199306))
49 static int atm_netif_rtdel __P((struct radix_node *, void *));
51 static int atm_if_ioctl __P((struct ifnet *, u_long, caddr_t));
52 static int atm_ifparse __P((char *, char *, int, int *));
57 static int (*atm_ifouttbl[AF_MAX+1])
58 __P((struct ifnet *, KBuffer *, struct sockaddr *))
63 * Register an ATM physical interface
65 * Each ATM device interface must register itself here upon completing
66 * its internal initialization. This applies to both linked and loaded
67 * device drivers. The interface must be registered before a signalling
68 * manager can be attached.
71 * cup pointer to interface's common unit structure
72 * name pointer to device name string
73 * sdp pointer to interface's stack services
76 * 0 registration successful
77 * errno registration failed - reason indicated
81 atm_physif_register(cup, name, sdp)
84 struct stack_defn *sdp;
90 * See if we need to be initialized
96 * Make sure we're not already registered
98 if (cup->cu_flags & CUF_REGISTER) {
105 * Make sure an interface is only registered once
107 for (pip = atm_interface_head; pip != NULL; pip = pip->pif_next) {
108 if ((cup->cu_unit == pip->pif_unit) &&
109 (strcmp(name, pip->pif_name) == 0)) {
116 * Fill in physical interface parameters
119 pip->pif_name = name;
120 pip->pif_unit = cup->cu_unit;
121 pip->pif_flags = PIF_UP;
122 pip->pif_services = sdp;
123 pip->pif_ioctl = atm_physif_ioctl;
126 * Link in the interface and mark us registered
128 LINK2TAIL(pip, struct atm_pif, atm_interface_head, pif_next);
129 cup->cu_flags |= CUF_REGISTER;
137 * De-register an ATM physical interface
139 * Each ATM interface must de-register itself before downing the interface.
140 * The interface's signalling manager will be detached and any network
141 * interface and VCC control blocks will be freed.
144 * cup pointer to interface's common unit structure
147 * 0 de-registration successful
148 * errno de-registration failed - reason indicated
152 atm_physif_deregister(cup)
155 struct atm_pif *pip = (struct atm_pif *)&cup->cu_pif;
161 * Detach and deregister, if needed
163 if ((cup->cu_flags & CUF_REGISTER)) {
166 * Detach from signalling manager
168 if (pip->pif_sigmgr != NULL) {
169 err = atm_sigmgr_detach(pip);
170 if (err && (err != ENOENT)) {
177 * Make sure signalling manager is detached
179 if (pip->pif_sigmgr != NULL) {
187 UNLINK(pip, struct atm_pif, atm_interface_head, pif_next);
189 cup->cu_flags &= ~CUF_REGISTER;
193 * Free all of our network interfaces
195 atm_physif_freenifs(pip);
198 * Free unit's vcc information
205 cup->cu_vcc = (Cmn_vcc *)NULL;
214 * Free all network interfaces on a physical interface
217 * pip pointer to physical interface structure
224 atm_physif_freenifs(pip)
227 struct atm_nif *nip = pip->pif_nif;
233 * atm_nif_detach zeros pointers - save so we can
236 struct atm_nif *nipp = nip->nif_pnext;
239 * Clean up network i/f trails
241 atm_nif_detach ( nip );
242 atm_free ((caddr_t)nip);
245 pip->pif_nif = (struct atm_nif *)NULL;
254 * Handle physical interface ioctl's
256 * See <netatm/atm_ioctl.h> for definitions.
261 * code Ioctl function (sub)code
262 * data Data block. On input contains command,
263 * on output, contains results
264 * arg Optional code specific arguments
267 * 0 Request processed successfully
268 * errno Request failed - reason code
272 atm_physif_ioctl(code, data, arg)
277 struct atminfreq *aip = (struct atminfreq *)data;
278 struct atmsetreq *asr = (struct atmsetreq *)data;
286 caddr_t buf = aip->air_buf_addr;
287 struct air_phy_stat_rsp *apsp;
288 struct air_int_rsp apr;
289 struct air_netif_rsp anr;
290 struct air_cfg_rsp acr;
291 int count, len, buf_len = aip->air_buf_len;
293 char ifname[2*IFNAMSIZ];
294 #if (defined(BSD) && (BSD >= 199103))
296 struct in_ifaddr *ia;
297 struct sockaddr_dl *sdl;
301 switch ( aip->air_opcode ) {
305 * Get physical interface information
307 aip = (struct atminfreq *)data;
308 pip = (struct atm_pif *)arg;
311 * Make sure there's room in user buffer
313 if (aip->air_buf_len < sizeof(apr)) {
319 * Fill in info to be returned
321 KM_ZERO((caddr_t)&apr, sizeof(apr));
322 smp = pip->pif_sigmgr;
323 sip = pip->pif_siginst;
324 (void) snprintf(apr.anp_intf, sizeof(apr.anp_intf),
325 "%s%d", pip->pif_name, pip->pif_unit );
328 strcpy(apr.anp_nif_pref, pip->pif_nif->nif_if.if_name);
333 nip = nip->nif_pnext;
337 ATM_ADDR_COPY(&sip->si_addr, &apr.anp_addr);
338 ATM_ADDR_COPY(&sip->si_subaddr, &apr.anp_subaddr);
339 apr.anp_sig_proto = smp->sm_proto;
340 apr.anp_sig_state = sip->si_state;
344 * Copy data to user buffer
346 err = copyout((caddr_t)&apr, aip->air_buf_addr, sizeof(apr));
351 * Update buffer pointer/count
353 aip->air_buf_addr += sizeof(apr);
354 aip->air_buf_len -= sizeof(apr);
359 * Get network interface information
361 aip = (struct atminfreq *)data;
362 nip = (struct atm_nif *)arg;
367 * Make sure there's room in user buffer
369 if (aip->air_buf_len < sizeof(anr)) {
375 * Fill in info to be returned
377 KM_ZERO((caddr_t)&anr, sizeof(anr));
378 (void) snprintf(anr.anp_intf, sizeof(anr.anp_intf),
379 "%s%d", ifp->if_name, ifp->if_unit);
382 anr.anp_proto_addr = *ia->ia_ifa.ifa_addr;
384 (void) snprintf(anr.anp_phy_intf, sizeof(anr.anp_phy_intf),
385 "%s%d", pip->pif_name, pip->pif_unit);
388 * Copy data to user buffer
390 err = copyout((caddr_t)&anr, aip->air_buf_addr, sizeof(anr));
395 * Update buffer pointer/count
397 aip->air_buf_addr += sizeof(anr);
398 aip->air_buf_len -= sizeof(anr);
403 * Get per interface statistics
405 pip = (struct atm_pif *)arg;
408 snprintf ( ifname, sizeof(ifname),
409 "%s%d", pip->pif_name, pip->pif_unit );
412 * Cast response into users buffer
414 apsp = (struct air_phy_stat_rsp *)buf;
419 len = sizeof ( struct air_phy_stat_rsp );
424 * Copy interface name into response
426 if ((err = copyout ( ifname, apsp->app_intf, IFNAMSIZ)) != 0)
432 if ((err = copyout(&pip->pif_ipdus, &apsp->app_ipdus,
433 len - sizeof(apsp->app_intf))) != 0)
437 * Adjust buffer elements
442 aip->air_buf_addr = buf;
443 aip->air_buf_len = buf_len;
448 * Set NIF - allow user to configure 1 or more logical
449 * interfaces per physical interface.
453 * Get pointer to physical interface structure from
456 pip = (struct atm_pif *)arg;
457 cup = (Cmn_unit *)pip;
460 * Sanity check - are we already connected to something?
462 if ( pip->pif_sigmgr )
469 * Free any previously allocated NIFs
471 atm_physif_freenifs(pip);
474 * Add list of interfaces
476 for ( count = 0; count < asr->asr_nif_cnt; count++ )
478 nip = (struct atm_nif *)atm_allocate(cup->cu_nif_pool);
482 * Destroy any successful nifs
484 atm_physif_freenifs(pip);
492 strcpy ( nip->nif_name, asr->asr_nif_pref );
493 nip->nif_sel = count;
495 ifp->if_name = nip->nif_name;
496 ifp->if_unit = count;
497 ifp->if_mtu = ATM_NIF_MTU;
498 ifp->if_flags = IFF_UP | IFF_BROADCAST | IFF_RUNNING;
499 ifp->if_output = atm_ifoutput;
500 ifp->if_ioctl = atm_if_ioctl;
501 ifp->if_snd.ifq_maxlen = ifqmaxlen;
502 #if (defined(BSD) && (BSD >= 199103))
504 * Set if_type and if_baudrate
506 ifp->if_type = IFT_ATM;
507 switch ( cup->cu_config.ac_media ) {
509 ifp->if_baudrate = 100000000;
512 ifp->if_baudrate = 140000000;
517 ifp->if_baudrate = 155000000;
522 if ((err = atm_nif_attach(nip)) != 0) {
523 atm_free ( (caddr_t)nip );
526 * Destroy any successful nifs
528 atm_physif_freenifs(pip);
531 #if (defined(BSD) && (BSD >= 199103))
533 * Set macaddr in <Link> address
536 ifa = ifnet_addrs[ifp->if_index - 1];
538 sdl = (struct sockaddr_dl *)
540 sdl->sdl_type = IFT_ETHER;
541 sdl->sdl_alen = ifp->if_addrlen;
542 bcopy ( (caddr_t)&cup->cu_config.ac_macaddr,
543 LLADDR(sdl), ifp->if_addrlen );
551 * Get adapter configuration information
553 aip = (struct atminfreq *)data;
554 pip = (struct atm_pif *)arg;
555 cup = (Cmn_unit *)pip;
556 acp = &cup->cu_config;
559 * Make sure there's room in user buffer
561 if (aip->air_buf_len < sizeof(acr)) {
567 * Fill in info to be returned
569 KM_ZERO((caddr_t)&acr, sizeof(acr));
570 (void) snprintf(acr.acp_intf, sizeof(acr.acp_intf),
571 "%s%d", pip->pif_name, pip->pif_unit);
572 KM_COPY((caddr_t)acp, (caddr_t)&acr.acp_cfg,
576 * Copy data to user buffer
578 err = copyout((caddr_t)&acr, aip->air_buf_addr,
584 * Update buffer pointer/count
586 aip->air_buf_addr += sizeof(acr);
587 aip->air_buf_len -= sizeof(acr);
592 * Pass off to device-specific handler
594 cup = (Cmn_unit *)arg;
598 err = (*cup->cu_ioctl)(code, data, arg);
610 * Register a Network Convergence Module
612 * Each ATM network convergence module must register itself here before
613 * it will receive network interface status notifications.
616 * ncp pointer to network convergence definition structure
619 * 0 registration successful
620 * errno registration failed - reason indicated
624 atm_netconv_register(ncp)
631 * See if we need to be initialized
637 * Validate protocol family
639 if (ncp->ncm_family > AF_MAX) {
645 * Ensure no duplicates
647 for (tdp = atm_netconv_head; tdp != NULL; tdp = tdp->ncm_next) {
648 if (tdp->ncm_family == ncp->ncm_family) {
657 LINK2TAIL(ncp, struct atm_ncm, atm_netconv_head, ncm_next);
660 * Add new interface output function
662 atm_ifouttbl[ncp->ncm_family] = ncp->ncm_ifoutput;
670 * De-register an ATM Network Convergence Module
672 * Each ATM network convergence provider must de-register its registered
673 * service(s) before terminating. Specifically, loaded kernel modules
674 * must de-register their services before unloading themselves.
677 * ncp pointer to network convergence definition structure
680 * 0 de-registration successful
681 * errno de-registration failed - reason indicated
685 atm_netconv_deregister(ncp)
688 int found, s = splnet();
691 * Remove module from list
693 UNLINKF(ncp, struct atm_ncm, atm_netconv_head, ncm_next, found);
701 * Remove module's interface output function
703 atm_ifouttbl[ncp->ncm_family] = NULL;
711 * Attach an ATM Network Interface
713 * Before an ATM network interface can be used by the system, the owning
714 * device interface must attach the network interface using this function.
715 * The physical interface for this network interface must have been previously
716 * registered (using atm_interface_register). The network interface will be
717 * added to the kernel's interface list and to the physical interface's list.
718 * The caller is responsible for initializing the control block fields.
721 * nip pointer to atm network interface control block
724 * 0 attach successful
725 * errno attach failed - reason indicated
732 struct atm_pif *pip, *pip2;
743 * Verify physical interface is registered
745 for (pip2 = atm_interface_head; pip2 != NULL; pip2 = pip2->pif_next) {
749 if ((pip == NULL) || (pip2 == NULL)) {
755 * Add to system interface list
760 * Add to physical interface list
762 LINK2TAIL(nip, struct atm_nif, pip->pif_nif, nif_pnext);
765 * Notify network convergence modules of new network i/f
767 for (ncp = atm_netconv_head; ncp; ncp = ncp->ncm_next) {
770 err = (*ncp->ncm_stat)(NCM_ATTACH, nip, 0);
784 * Detach an ATM Network Interface
786 * Before an ATM network interface control block can be freed, all kernel
787 * references to/from this block must be released. This function will delete
788 * all routing references to the interface and free all interface addresses
789 * for the interface. The network interface will then be removed from the
790 * kernel's interface list and from the owning physical interface's list.
791 * The caller is responsible for free'ing the control block.
794 * nip pointer to atm network interface control block
806 struct ifnet *ifp = &nip->nif_if;
808 struct in_ifaddr *ia;
809 struct radix_node_head *rnh;
815 * Notify convergence modules of network i/f demise
817 for (ncp = atm_netconv_head; ncp; ncp = ncp->ncm_next) {
818 (void) (*ncp->ncm_stat)(NCM_DETACH, nip, 0);
822 * Mark interface down
827 * Free all interface routes and addresses
834 /* Delete interface route */
837 /* Remove interface address from queues */
839 TAILQ_REMOVE(&ifp->if_addrhead, ifa, ifa_link);
840 TAILQ_REMOVE(&in_ifaddrhead, ia, ia_link);
842 /* Free interface address */
847 * Delete all remaining routes using this interface
848 * Unfortuneatly the only way to do this is to slog through
849 * the entire routing table looking for routes which point
850 * to this interface...oh well...
852 for (i = 1; i <= AF_MAX; i++) {
853 if ((rnh = rt_tables[i]) == NULL)
855 (void) rnh->rnh_walktree(rnh, atm_netif_rtdel, ifp);
859 * Remove from system interface list (ie. if_detach())
861 TAILQ_REMOVE(&ifnet, ifp, if_link);
864 * Remove from physical interface list
866 UNLINK(nip, struct atm_nif, nip->nif_pif->pif_nif, nif_pnext);
873 * Delete Routes for a Network Interface
875 * Called for each routing entry via the rnh->rnh_walktree() call above
876 * to delete all route entries referencing a detaching network interface.
879 * rn pointer to node in the routing table
880 * arg argument passed to rnh->rnh_walktree() - detaching interface
884 * errno failed - reason indicated
888 atm_netif_rtdel(rn, arg)
889 struct radix_node *rn;
892 struct rtentry *rt = (struct rtentry *)rn;
893 struct ifnet *ifp = arg;
896 if (rt->rt_ifp == ifp) {
899 * Protect (sorta) against walktree recursion problems
902 if ((rt->rt_flags & RTF_UP) == 0)
905 err = rtrequest(RTM_DELETE, rt_key(rt), rt->rt_gateway,
906 rt_mask(rt), rt->rt_flags,
907 (struct rtentry **) NULL);
909 log(LOG_WARNING, "atm_netif_rtdel: error %d\n", err);
918 * Set an ATM Network Interface address
920 * This is called from a device interface when processing an SIOCSIFADDR
921 * ioctl request. We just notify all convergence modules of the new address
922 * and hope everyone has non-overlapping interests, since if someone reports
923 * an error we don't go back and tell everyone to undo the change.
926 * nip pointer to atm network interface control block
927 * ifa pointer to new interface address
931 * errno set failed - reason indicated
935 atm_nif_setaddr(nip, ifa)
940 int err = 0, s = splnet();
943 * Notify convergence modules of network i/f change
945 for (ncp = atm_netconv_head; ncp; ncp = ncp->ncm_next) {
946 err = (*ncp->ncm_stat)(NCM_SETADDR, nip, (int)ifa);
957 * ATM Interface Packet Output
959 * All ATM network interfaces must have their ifnet if_output address set to
960 * this function. Since no existing network layer code is to be modified
961 * for ATM support, this function serves as the hook to allow network output
962 * packets to be assigned to their proper outbound VCC. Each network address
963 * family which is to be supported over ATM must be assigned an output
964 * packet processing function via atm_netconv_register().
967 * ifp pointer to ifnet structure
968 * m pointer to packet buffer chain to be output
969 * dst pointer to packet's network destination address
972 * 0 packet queued to interface
973 * errno output failed - reason indicated
977 #if (defined(BSD) && (BSD >= 199103))
978 atm_ifoutput(ifp, m, dst, rt)
980 atm_ifoutput(ifp, m, dst)
984 struct sockaddr *dst;
985 #if (defined(BSD) && (BSD >= 199103))
989 u_short fam = dst->sa_family;
990 int (*func)__P((struct ifnet *, KBuffer *,
994 * Validate address family
998 return (EAFNOSUPPORT);
1002 * Hand packet off for dst-to-VCC mapping
1004 func = atm_ifouttbl[fam];
1007 return (EAFNOSUPPORT);
1009 return ((*func)(ifp, m, dst));
1014 * Handle interface ioctl requests.
1017 * ifp pointer to network interface structure
1019 * data arguments to/from ioctl
1025 atm_if_ioctl(ifp, cmd, data)
1030 register struct ifreq *ifr = (struct ifreq *)data;
1031 struct atm_nif *nip = (struct atm_nif *)ifp;
1038 KM_COPY ( (caddr_t)&(nip->nif_pif->pif_macaddr),
1039 (caddr_t)ifr->ifr_addr.sa_data,
1040 sizeof(struct mac_addr) );
1044 error = atm_nif_setaddr ( nip, (struct ifaddr *)data);
1045 ifp->if_flags |= IFF_UP | IFF_RUNNING | IFF_BROADCAST;
1049 *(short *)data = ifp->if_flags;
1066 * Parse interface name
1068 * Parses an interface name string into a name and a unit component.
1071 * name pointer to interface name string
1072 * namep address to store interface name
1073 * size size available at namep
1074 * unitp address to store interface unit number
1082 atm_ifparse(name, namep, size, unitp)
1089 int len = 0, unit = 0;
1092 * Separate supplied string into name and unit parts.
1097 if (*cp >= '0' && *cp <= '9')
1104 while (*cp && *cp >= '0' && *cp <= '9')
1105 unit = 10 * unit + *cp++ - '0';
1114 * Locate ATM physical interface via name
1116 * Uses the supplied interface name string to locate a registered
1117 * ATM physical interface.
1120 * name pointer to interface name string
1123 * 0 interface not found
1124 * else pointer to atm physical interface structure
1131 struct atm_pif *pip;
1138 if (atm_ifparse(name, n, sizeof(n), &unit))
1139 return ((struct atm_pif *)0);
1142 * Look for the physical interface
1144 for (pip = atm_interface_head; pip; pip = pip->pif_next) {
1145 if ((pip->pif_unit == unit) && (strcmp(pip->pif_name, n) == 0))
1154 * Locate ATM network interface via name
1156 * Uses the supplied interface name string to locate an ATM network interface.
1159 * name pointer to interface name string
1162 * 0 interface not found
1163 * else pointer to atm network interface structure
1170 struct atm_pif *pip;
1171 struct atm_nif *nip;
1178 if (atm_ifparse(name, n, sizeof(n), &unit))
1179 return ((struct atm_nif *)0);
1182 * Search thru each physical interface
1184 for (pip = atm_interface_head; pip; pip = pip->pif_next) {
1186 * Looking for network interface
1188 for (nip = pip->pif_nif; nip; nip = nip->nif_pnext) {
1189 struct ifnet *ifp = (struct ifnet *)nip;
1190 if ((ifp->if_unit == unit) &&
1191 (strcmp(ifp->if_name, n) == 0))