4 * Phonet protocols family
6 * Copyright (C) 2008 Nokia Corporation.
8 * Contact: Remi Denis-Courmont <remi.denis-courmont@nokia.com>
9 * Original author: Sakari Ailus <sakari.ailus@nokia.com>
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * version 2 as published by the Free Software Foundation.
15 * This program is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
26 #include <linux/kernel.h>
27 #include <linux/module.h>
28 #include <linux/slab.h>
29 #include <asm/unaligned.h>
32 #include <linux/if_phonet.h>
33 #include <linux/phonet.h>
34 #include <net/phonet/phonet.h>
35 #include <net/phonet/pn_dev.h>
37 /* Transport protocol registration */
38 static struct phonet_protocol *proto_tab[PHONET_NPROTO] __read_mostly;
40 static struct phonet_protocol *phonet_proto_get(int protocol)
42 struct phonet_protocol *pp;
44 if (protocol >= PHONET_NPROTO)
48 pp = rcu_dereference(proto_tab[protocol]);
49 if (pp && !try_module_get(pp->prot->owner))
56 static inline void phonet_proto_put(struct phonet_protocol *pp)
58 module_put(pp->prot->owner);
61 /* protocol family functions */
63 static int pn_socket_create(struct net *net, struct socket *sock, int protocol,
68 struct phonet_protocol *pnp;
71 if (!capable(CAP_SYS_ADMIN))
75 /* Default protocol selection */
78 protocol = PN_PROTO_PHONET;
81 protocol = PN_PROTO_PIPE;
84 return -EPROTONOSUPPORT;
88 pnp = phonet_proto_get(protocol);
90 request_module("net-pf-%d-proto-%d", PF_PHONET, protocol) == 0)
91 pnp = phonet_proto_get(protocol);
94 return -EPROTONOSUPPORT;
95 if (sock->type != pnp->sock_type) {
96 err = -EPROTONOSUPPORT;
100 sk = sk_alloc(net, PF_PHONET, GFP_KERNEL, pnp->prot);
106 sock_init_data(sock, sk);
107 sock->state = SS_UNCONNECTED;
108 sock->ops = pnp->ops;
109 sk->sk_backlog_rcv = sk->sk_prot->backlog_rcv;
110 sk->sk_protocol = protocol;
114 sk->sk_prot->init(sk);
118 phonet_proto_put(pnp);
122 static const struct net_proto_family phonet_proto_family = {
124 .create = pn_socket_create,
125 .owner = THIS_MODULE,
128 /* Phonet device header operations */
129 static int pn_header_create(struct sk_buff *skb, struct net_device *dev,
130 unsigned short type, const void *daddr,
131 const void *saddr, unsigned len)
133 u8 *media = skb_push(skb, 1);
135 if (type != ETH_P_PHONET)
139 saddr = dev->dev_addr;
140 *media = *(const u8 *)saddr;
144 static int pn_header_parse(const struct sk_buff *skb, unsigned char *haddr)
146 const u8 *media = skb_mac_header(skb);
151 struct header_ops phonet_header_ops = {
152 .create = pn_header_create,
153 .parse = pn_header_parse,
155 EXPORT_SYMBOL(phonet_header_ops);
158 * Prepends an ISI header and sends a datagram.
160 static int pn_send(struct sk_buff *skb, struct net_device *dev,
161 u16 dst, u16 src, u8 res, u8 irq)
163 struct phonethdr *ph;
166 if (skb->len + 2 > 0xffff /* Phonet length field limit */ ||
167 skb->len + sizeof(struct phonethdr) > dev->mtu) {
172 /* Broadcast sending is not implemented */
173 if (pn_addr(dst) == PNADDR_BROADCAST) {
178 skb_reset_transport_header(skb);
179 WARN_ON(skb_headroom(skb) & 1); /* HW assumes word alignment */
180 skb_push(skb, sizeof(struct phonethdr));
181 skb_reset_network_header(skb);
183 ph->pn_rdev = pn_dev(dst);
184 ph->pn_sdev = pn_dev(src);
186 ph->pn_length = __cpu_to_be16(skb->len + 2 - sizeof(*ph));
187 ph->pn_robj = pn_obj(dst);
188 ph->pn_sobj = pn_obj(src);
190 skb->protocol = htons(ETH_P_PHONET);
194 if (skb->pkt_type == PACKET_LOOPBACK) {
195 skb_reset_mac_header(skb);
203 err = dev_hard_header(skb, dev, ntohs(skb->protocol),
204 NULL, NULL, skb->len);
209 err = dev_queue_xmit(skb);
218 static int pn_raw_send(const void *data, int len, struct net_device *dev,
219 u16 dst, u16 src, u8 res)
221 struct sk_buff *skb = alloc_skb(MAX_PHONET_HEADER + len, GFP_ATOMIC);
225 if (phonet_address_lookup(dev_net(dev), pn_addr(dst)) == 0)
226 skb->pkt_type = PACKET_LOOPBACK;
228 skb_reserve(skb, MAX_PHONET_HEADER);
230 skb_copy_to_linear_data(skb, data, len);
231 return pn_send(skb, dev, dst, src, res, 1);
235 * Create a Phonet header for the skb and send it out. Returns
236 * non-zero error code if failed. The skb is freed then.
238 int pn_skb_send(struct sock *sk, struct sk_buff *skb,
239 const struct sockaddr_pn *target)
241 struct net *net = sock_net(sk);
242 struct net_device *dev;
243 struct pn_sock *pn = pn_sk(sk);
246 u8 daddr = pn_sockaddr_get_addr(target), saddr = PN_NO_ADDR;
249 if (sk->sk_bound_dev_if)
250 dev = dev_get_by_index(net, sk->sk_bound_dev_if);
251 else if (phonet_address_lookup(net, daddr) == 0) {
252 dev = phonet_device_get(net);
253 skb->pkt_type = PACKET_LOOPBACK;
255 dev = phonet_route_output(net, daddr);
257 if (!dev || !(dev->flags & IFF_UP))
260 saddr = phonet_address_get(dev, daddr);
261 if (saddr == PN_NO_ADDR)
266 src = pn_object(saddr, pn_obj(src));
268 err = pn_send(skb, dev, pn_sockaddr_get_object(target),
269 src, pn_sockaddr_get_resource(target), 0);
279 EXPORT_SYMBOL(pn_skb_send);
281 /* Do not send an error message in response to an error message */
282 static inline int can_respond(struct sk_buff *skb)
284 const struct phonethdr *ph;
285 const struct phonetmsg *pm;
288 if (!pskb_may_pull(skb, 3))
292 if (ph->pn_res == PN_PREFIX && !pskb_may_pull(skb, 5))
294 if (ph->pn_res == PN_COMMGR) /* indications */
297 ph = pn_hdr(skb); /* re-acquires the pointer */
299 if (pm->pn_msg_id != PN_COMMON_MESSAGE)
301 submsg_id = (ph->pn_res == PN_PREFIX)
302 ? pm->pn_e_submsg_id : pm->pn_submsg_id;
303 if (submsg_id != PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP &&
304 pm->pn_e_submsg_id != PN_COMM_SERVICE_NOT_IDENTIFIED_RESP)
309 static int send_obj_unreachable(struct sk_buff *rskb)
311 const struct phonethdr *oph = pn_hdr(rskb);
312 const struct phonetmsg *opm = pn_msg(rskb);
313 struct phonetmsg resp;
315 memset(&resp, 0, sizeof(resp));
316 resp.pn_trans_id = opm->pn_trans_id;
317 resp.pn_msg_id = PN_COMMON_MESSAGE;
318 if (oph->pn_res == PN_PREFIX) {
319 resp.pn_e_res_id = opm->pn_e_res_id;
320 resp.pn_e_submsg_id = PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP;
321 resp.pn_e_orig_msg_id = opm->pn_msg_id;
322 resp.pn_e_status = 0;
324 resp.pn_submsg_id = PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP;
325 resp.pn_orig_msg_id = opm->pn_msg_id;
328 return pn_raw_send(&resp, sizeof(resp), rskb->dev,
329 pn_object(oph->pn_sdev, oph->pn_sobj),
330 pn_object(oph->pn_rdev, oph->pn_robj),
334 static int send_reset_indications(struct sk_buff *rskb)
336 struct phonethdr *oph = pn_hdr(rskb);
337 static const u8 data[4] = {
338 0x00 /* trans ID */, 0x10 /* subscribe msg */,
339 0x00 /* subscription count */, 0x00 /* dummy */
342 return pn_raw_send(data, sizeof(data), rskb->dev,
343 pn_object(oph->pn_sdev, 0x00),
344 pn_object(oph->pn_rdev, oph->pn_robj),
349 /* packet type functions */
352 * Stuff received packets to associated sockets.
353 * On error, returns non-zero and releases the skb.
355 static int phonet_rcv(struct sk_buff *skb, struct net_device *dev,
356 struct packet_type *pkttype,
357 struct net_device *orig_dev)
359 struct net *net = dev_net(dev);
360 struct phonethdr *ph;
361 struct sockaddr_pn sa;
364 /* check we have at least a full Phonet header */
365 if (!pskb_pull(skb, sizeof(struct phonethdr)))
368 /* check that the advertised length is correct */
370 len = get_unaligned_be16(&ph->pn_length);
374 if ((len > skb->len) || pskb_trim(skb, len))
376 skb_reset_transport_header(skb);
378 pn_skb_get_dst_sockaddr(skb, &sa);
380 /* check if this is broadcasted */
381 if (pn_sockaddr_get_addr(&sa) == PNADDR_BROADCAST) {
382 pn_deliver_sock_broadcast(net, skb);
386 /* check if we are the destination */
387 if (phonet_address_lookup(net, pn_sockaddr_get_addr(&sa)) == 0) {
388 /* Phonet packet input */
389 struct sock *sk = pn_find_sock_by_sa(net, &sa);
392 return sk_receive_skb(sk, skb, 0);
394 if (can_respond(skb)) {
395 send_obj_unreachable(skb);
396 send_reset_indications(skb);
398 } else if (unlikely(skb->pkt_type == PACKET_LOOPBACK))
399 goto out; /* Race between address deletion and loopback */
401 /* Phonet packet routing */
402 struct net_device *out_dev;
404 out_dev = phonet_route_output(net, pn_sockaddr_get_addr(&sa));
406 LIMIT_NETDEBUG(KERN_WARNING"No Phonet route to %02X\n",
407 pn_sockaddr_get_addr(&sa));
411 __skb_push(skb, sizeof(struct phonethdr));
413 if (out_dev == dev) {
414 LIMIT_NETDEBUG(KERN_ERR"Phonet loop to %02X on %s\n",
415 pn_sockaddr_get_addr(&sa), dev->name);
418 /* Some drivers (e.g. TUN) do not allocate HW header space */
419 if (skb_cow_head(skb, out_dev->hard_header_len))
422 if (dev_hard_header(skb, out_dev, ETH_P_PHONET, NULL, NULL,
427 return NET_RX_SUCCESS;
437 static struct packet_type phonet_packet_type __read_mostly = {
438 .type = cpu_to_be16(ETH_P_PHONET),
442 static DEFINE_MUTEX(proto_tab_lock);
444 int __init_or_module phonet_proto_register(int protocol,
445 struct phonet_protocol *pp)
449 if (protocol >= PHONET_NPROTO)
452 err = proto_register(pp->prot, 1);
456 mutex_lock(&proto_tab_lock);
457 if (proto_tab[protocol])
460 rcu_assign_pointer(proto_tab[protocol], pp);
461 mutex_unlock(&proto_tab_lock);
465 EXPORT_SYMBOL(phonet_proto_register);
467 void phonet_proto_unregister(int protocol, struct phonet_protocol *pp)
469 mutex_lock(&proto_tab_lock);
470 BUG_ON(proto_tab[protocol] != pp);
471 rcu_assign_pointer(proto_tab[protocol], NULL);
472 mutex_unlock(&proto_tab_lock);
474 proto_unregister(pp->prot);
476 EXPORT_SYMBOL(phonet_proto_unregister);
478 /* Module registration */
479 static int __init phonet_init(void)
483 err = phonet_device_init();
488 err = sock_register(&phonet_proto_family);
491 "phonet protocol family initialization failed\n");
495 dev_add_pack(&phonet_packet_type);
496 phonet_sysctl_init();
498 err = isi_register();
504 phonet_sysctl_exit();
505 sock_unregister(PF_PHONET);
506 dev_remove_pack(&phonet_packet_type);
508 phonet_device_exit();
512 static void __exit phonet_exit(void)
515 phonet_sysctl_exit();
516 sock_unregister(PF_PHONET);
517 dev_remove_pack(&phonet_packet_type);
518 phonet_device_exit();
521 module_init(phonet_init);
522 module_exit(phonet_exit);
523 MODULE_DESCRIPTION("Phonet protocol stack for Linux");
524 MODULE_LICENSE("GPL");
525 MODULE_ALIAS_NETPROTO(PF_PHONET);