SAFE public projects git trees. - safe/jmp/linux-2.6/blob - include/linux/phonet.h

   1 /**
   2  * file phonet.h
   3  *
   4  * Phonet sockets kernel interface
   5  *
   6  * Copyright (C) 2008 Nokia Corporation. All rights reserved.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * version 2 as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
  20  * 02110-1301 USA
  21  */
  22
  23 #ifndef LINUX_PHONET_H
  24 #define LINUX_PHONET_H
  25
  26 /* Automatic protocol selection */
  27 #define PN_PROTO_TRANSPORT      0
  28 /* Phonet datagram socket */
  29 #define PN_PROTO_PHONET         1
  30 #define PHONET_NPROTO           2
  31
  32 #define PNADDR_ANY              0
  33 #define PNPORT_RESOURCE_ROUTING 0
  34
  35 /* ioctls */
  36 #define SIOCPNGETOBJECT         (SIOCPROTOPRIVATE + 0)
  37
  38 /* Phonet protocol header */
  39 struct phonethdr {
  40         __u8    pn_rdev;
  41         __u8    pn_sdev;
  42         __u8    pn_res;
  43         __be16  pn_length;
  44         __u8    pn_robj;
  45         __u8    pn_sobj;
  46 } __attribute__((packed));
  47
  48 /* Common Phonet payload header */
  49 struct phonetmsg {
  50         __u8    pn_trans_id;    /* transaction ID */
  51         __u8    pn_msg_id;      /* message type */
  52         union {
  53                 struct {
  54                         __u8    pn_submsg_id;   /* message subtype */
  55                         __u8    pn_data[5];
  56                 } base;
  57                 struct {
  58                         __u16   pn_e_res_id;    /* extended resource ID */
  59                         __u8    pn_e_submsg_id; /* message subtype */
  60                         __u8    pn_e_data[3];
  61                 } ext;
  62         } pn_msg_u;
  63 };
  64 #define PN_COMMON_MESSAGE       0xF0
  65 #define PN_PREFIX               0xE0 /* resource for extended messages */
  66 #define pn_submsg_id            pn_msg_u.base.pn_submsg_id
  67 #define pn_e_submsg_id          pn_msg_u.ext.pn_e_submsg_id
  68 #define pn_e_res_id             pn_msg_u.ext.pn_e_res_id
  69 #define pn_data                 pn_msg_u.base.pn_data
  70 #define pn_e_data               pn_msg_u.ext.pn_e_data
  71
  72 /* data for unreachable errors */
  73 #define PN_COMM_SERVICE_NOT_IDENTIFIED_RESP     0x01
  74 #define PN_COMM_ISA_ENTITY_NOT_REACHABLE_RESP   0x14
  75 #define pn_orig_msg_id          pn_data[0]
  76 #define pn_status               pn_data[1]
  77 #define pn_e_orig_msg_id        pn_e_data[0]
  78 #define pn_e_status             pn_e_data[1]
  79
  80 /* Phonet socket address structure */
  81 struct sockaddr_pn {
  82         sa_family_t spn_family;
  83         __u8 spn_obj;
  84         __u8 spn_dev;
  85         __u8 spn_resource;
  86         __u8 spn_zero[sizeof(struct sockaddr) - sizeof(sa_family_t) - 3];
  87 } __attribute__ ((packed));
  88
  89 static inline __u16 pn_object(__u8 addr, __u16 port)
  90 {
  91         return (addr << 8) | (port & 0x3ff);
  92 }
  93
  94 static inline __u8 pn_obj(__u16 handle)
  95 {
  96         return handle & 0xff;
  97 }
  98
  99 static inline __u8 pn_dev(__u16 handle)
 100 {
 101         return handle >> 8;
 102 }
 103
 104 static inline __u16 pn_port(__u16 handle)
 105 {
 106         return handle & 0x3ff;
 107 }
 108
 109 static inline __u8 pn_addr(__u16 handle)
 110 {
 111         return (handle >> 8) & 0xfc;
 112 }
 113
 114 static inline void pn_sockaddr_set_addr(struct sockaddr_pn *spn, __u8 addr)
 115 {
 116         spn->spn_dev &= 0x03;
 117         spn->spn_dev |= addr & 0xfc;
 118 }
 119
 120 static inline void pn_sockaddr_set_port(struct sockaddr_pn *spn, __u16 port)
 121 {
 122         spn->spn_dev &= 0xfc;
 123         spn->spn_dev |= (port >> 8) & 0x03;
 124         spn->spn_obj = port & 0xff;
 125 }
 126
 127 static inline void pn_sockaddr_set_object(struct sockaddr_pn *spn,
 128                                                 __u16 handle)
 129 {
 130         spn->spn_dev = pn_dev(handle);
 131         spn->spn_obj = pn_obj(handle);
 132 }
 133
 134 static inline void pn_sockaddr_set_resource(struct sockaddr_pn *spn,
 135                                                 __u8 resource)
 136 {
 137         spn->spn_resource = resource;
 138 }
 139
 140 static inline __u8 pn_sockaddr_get_addr(const struct sockaddr_pn *spn)
 141 {
 142         return spn->spn_dev & 0xfc;
 143 }
 144
 145 static inline __u16 pn_sockaddr_get_port(const struct sockaddr_pn *spn)
 146 {
 147         return ((spn->spn_dev & 0x03) << 8) | spn->spn_obj;
 148 }
 149
 150 static inline __u16 pn_sockaddr_get_object(const struct sockaddr_pn *spn)
 151 {
 152         return pn_object(spn->spn_dev, spn->spn_obj);
 153 }
 154
 155 static inline __u8 pn_sockaddr_get_resource(const struct sockaddr_pn *spn)
 156 {
 157         return spn->spn_resource;
 158 }
 159
 160 #endif