include/uapi/linux/media.h

   1 /*
   2  * Multimedia device API
   3  *
   4  * Copyright (C) 2010 Nokia Corporation
   5  *
   6  * Contacts: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
   7  *           Sakari Ailus <sakari.ailus@iki.fi>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License version 2 as
  11  * published by the Free Software Foundation.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef __LINUX_MEDIA_H
  24 #define __LINUX_MEDIA_H
  25
  26 #ifndef __KERNEL__
  27 #include <stdint.h>
  28 #endif
  29 #include <linux/ioctl.h>
  30 #include <linux/types.h>
  31 #include <linux/version.h>
  32
  33 #define MEDIA_API_VERSION       KERNEL_VERSION(0, 1, 0)
  34
  35 struct media_device_info {
  36         char driver[16];
  37         char model[32];
  38         char serial[40];
  39         char bus_info[32];
  40         __u32 media_version;
  41         __u32 hw_revision;
  42         __u32 driver_version;
  43         __u32 reserved[31];
  44 };
  45
  46 #define MEDIA_ENT_ID_FLAG_NEXT          (1 << 31)
  47
  48 /*
  49  * Initial value to be used when a new entity is created
  50  * Drivers should change it to something useful
  51  */
  52 #define MEDIA_ENT_F_UNKNOWN     0x00000000
  53
  54 /*
  55  * Base number ranges for entity functions
  56  *
  57  * NOTE: those ranges and entity function number are phased just to
  58  * make it easier to maintain this file. Userspace should not rely on
  59  * the ranges to identify a group of function types, as newer
  60  * functions can be added with any name within the full u32 range.
  61  */
  62 #define MEDIA_ENT_F_BASE                0x00000000
  63 #define MEDIA_ENT_F_OLD_BASE            0x00010000
  64 #define MEDIA_ENT_F_OLD_SUBDEV_BASE     0x00020000
  65
  66 /*
  67  * DVB entities
  68  */
  69 #define MEDIA_ENT_F_DTV_DEMOD           (MEDIA_ENT_F_BASE + 1)
  70 #define MEDIA_ENT_F_TS_DEMUX            (MEDIA_ENT_F_BASE + 2)
  71 #define MEDIA_ENT_F_DTV_CA              (MEDIA_ENT_F_BASE + 3)
  72 #define MEDIA_ENT_F_DTV_NET_DECAP       (MEDIA_ENT_F_BASE + 4)
  73
  74 /*
  75  * Connectors
  76  */
  77 /* It is a responsibility of the entity drivers to add connectors and links */
  78 #define MEDIA_ENT_F_CONN_RF             (MEDIA_ENT_F_BASE + 21)
  79 #define MEDIA_ENT_F_CONN_SVIDEO         (MEDIA_ENT_F_BASE + 22)
  80 #define MEDIA_ENT_F_CONN_COMPOSITE      (MEDIA_ENT_F_BASE + 23)
  81 /* For internal test signal generators and other debug connectors */
  82 #define MEDIA_ENT_F_CONN_TEST           (MEDIA_ENT_F_BASE + 24)
  83
  84 /*
  85  * I/O entities
  86  */
  87 #define MEDIA_ENT_F_IO_DTV              (MEDIA_ENT_F_BASE + 31)
  88 #define MEDIA_ENT_F_IO_VBI              (MEDIA_ENT_F_BASE + 32)
  89 #define MEDIA_ENT_F_IO_SWRADIO          (MEDIA_ENT_F_BASE + 33)
  90
  91 /*
  92  * Don't touch on those. The ranges MEDIA_ENT_F_OLD_BASE and
  93  * MEDIA_ENT_F_OLD_SUBDEV_BASE are kept to keep backward compatibility
  94  * with the legacy v1 API.The number range is out of range by purpose:
  95  * several previously reserved numbers got excluded from this range.
  96  *
  97  * Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN,
  98  * in order to preserve backward compatibility.
  99  * Drivers must change to the proper subdev type before
 100  * registering the entity.
 101  */
 102
 103 #define MEDIA_ENT_F_IO_V4L              (MEDIA_ENT_F_OLD_BASE + 1)
 104
 105 #define MEDIA_ENT_F_CAM_SENSOR          (MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
 106 #define MEDIA_ENT_F_FLASH               (MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
 107 #define MEDIA_ENT_F_LENS                (MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
 108 #define MEDIA_ENT_F_ATV_DECODER         (MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
 109 /*
 110  * It is a responsibility of the entity drivers to add connectors and links
 111  *      for the tuner entities.
 112  */
 113 #define MEDIA_ENT_F_TUNER               (MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
 114
 115 #define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN MEDIA_ENT_F_OLD_SUBDEV_BASE
 116
 117 #ifndef __KERNEL__
 118
 119 /*
 120  * Legacy symbols used to avoid userspace compilation breakages
 121  *
 122  * Those symbols map the entity function into types and should be
 123  * used only on legacy programs for legacy hardware. Don't rely
 124  * on those for MEDIA_IOC_G_TOPOLOGY.
 125  */
 126 #define MEDIA_ENT_TYPE_SHIFT            16
 127 #define MEDIA_ENT_TYPE_MASK             0x00ff0000
 128 #define MEDIA_ENT_SUBTYPE_MASK          0x0000ffff
 129
 130 #define MEDIA_ENT_T_DEVNODE             MEDIA_ENT_F_OLD_BASE
 131 #define MEDIA_ENT_T_DEVNODE_V4L         MEDIA_ENT_F_IO_V4L
 132 #define MEDIA_ENT_T_DEVNODE_FB          (MEDIA_ENT_T_DEVNODE + 2)
 133 #define MEDIA_ENT_T_DEVNODE_ALSA        (MEDIA_ENT_T_DEVNODE + 3)
 134 #define MEDIA_ENT_T_DEVNODE_DVB         (MEDIA_ENT_T_DEVNODE + 4)
 135
 136 #define MEDIA_ENT_T_UNKNOWN             MEDIA_ENT_F_UNKNOWN
 137 #define MEDIA_ENT_T_V4L2_VIDEO          MEDIA_ENT_F_IO_V4L
 138 #define MEDIA_ENT_T_V4L2_SUBDEV         MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
 139 #define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR  MEDIA_ENT_F_CAM_SENSOR
 140 #define MEDIA_ENT_T_V4L2_SUBDEV_FLASH   MEDIA_ENT_F_FLASH
 141 #define MEDIA_ENT_T_V4L2_SUBDEV_LENS    MEDIA_ENT_F_LENS
 142 #define MEDIA_ENT_T_V4L2_SUBDEV_DECODER MEDIA_ENT_F_ATV_DECODER
 143 #define MEDIA_ENT_T_V4L2_SUBDEV_TUNER   MEDIA_ENT_F_TUNER
 144 #endif
 145
 146 /* Entity flags */
 147 #define MEDIA_ENT_FL_DEFAULT            (1 << 0)
 148 #define MEDIA_ENT_FL_CONNECTOR          (1 << 1)
 149
 150 struct media_entity_desc {
 151         __u32 id;
 152         char name[32];
 153         __u32 type;
 154         __u32 revision;
 155         __u32 flags;
 156         __u32 group_id;
 157         __u16 pads;
 158         __u16 links;
 159
 160         __u32 reserved[4];
 161
 162         union {
 163                 /* Node specifications */
 164                 struct {
 165                         __u32 major;
 166                         __u32 minor;
 167                 } dev;
 168
 169 #if 1
 170                 /*
 171                  * TODO: this shouldn't have been added without
 172                  * actual drivers that use this. When the first real driver
 173                  * appears that sets this information, special attention
 174                  * should be given whether this information is 1) enough, and
 175                  * 2) can deal with udev rules that rename devices. The struct
 176                  * dev would not be sufficient for this since that does not
 177                  * contain the subdevice information. In addition, struct dev
 178                  * can only refer to a single device, and not to multiple (e.g.
 179                  * pcm and mixer devices).
 180                  *
 181                  * So for now mark this as a to do.
 182                  */
 183                 struct {
 184                         __u32 card;
 185                         __u32 device;
 186                         __u32 subdevice;
 187                 } alsa;
 188 #endif
 189
 190 #if 1
 191                 /*
 192                  * DEPRECATED: previous node specifications. Kept just to
 193                  * avoid breaking compilation, but media_entity_desc.dev
 194                  * should be used instead. In particular, alsa and dvb
 195                  * fields below are wrong: for all devnodes, there should
 196                  * be just major/minor inside the struct, as this is enough
 197                  * to represent any devnode, no matter what type.
 198                  */
 199                 struct {
 200                         __u32 major;
 201                         __u32 minor;
 202                 } v4l;
 203                 struct {
 204                         __u32 major;
 205                         __u32 minor;
 206                 } fb;
 207                 int dvb;
 208 #endif
 209
 210                 /* Sub-device specifications */
 211                 /* Nothing needed yet */
 212                 __u8 raw[184];
 213         };
 214 };
 215
 216 #define MEDIA_PAD_FL_SINK               (1 << 0)
 217 #define MEDIA_PAD_FL_SOURCE             (1 << 1)
 218 #define MEDIA_PAD_FL_MUST_CONNECT       (1 << 2)
 219
 220 struct media_pad_desc {
 221         __u32 entity;           /* entity ID */
 222         __u16 index;            /* pad index */
 223         __u32 flags;            /* pad flags */
 224         __u32 reserved[2];
 225 };
 226
 227 #define MEDIA_LNK_FL_ENABLED            (1 << 0)
 228 #define MEDIA_LNK_FL_IMMUTABLE          (1 << 1)
 229 #define MEDIA_LNK_FL_DYNAMIC            (1 << 2)
 230
 231 #define MEDIA_LNK_FL_LINK_TYPE          (0xf << 28)
 232 #  define MEDIA_LNK_FL_DATA_LINK        (0 << 28)
 233 #  define MEDIA_LNK_FL_INTERFACE_LINK   (1 << 28)
 234
 235 struct media_link_desc {
 236         struct media_pad_desc source;
 237         struct media_pad_desc sink;
 238         __u32 flags;
 239         __u32 reserved[2];
 240 };
 241
 242 struct media_links_enum {
 243         __u32 entity;
 244         /* Should have enough room for pads elements */
 245         struct media_pad_desc __user *pads;
 246         /* Should have enough room for links elements */
 247         struct media_link_desc __user *links;
 248         __u32 reserved[4];
 249 };
 250
 251 /* Interface type ranges */
 252
 253 #define MEDIA_INTF_T_DVB_BASE   0x00000100
 254 #define MEDIA_INTF_T_V4L_BASE   0x00000200
 255
 256 /* Interface types */
 257
 258 #define MEDIA_INTF_T_DVB_FE     (MEDIA_INTF_T_DVB_BASE)
 259 #define MEDIA_INTF_T_DVB_DEMUX  (MEDIA_INTF_T_DVB_BASE + 1)
 260 #define MEDIA_INTF_T_DVB_DVR    (MEDIA_INTF_T_DVB_BASE + 2)
 261 #define MEDIA_INTF_T_DVB_CA     (MEDIA_INTF_T_DVB_BASE + 3)
 262 #define MEDIA_INTF_T_DVB_NET    (MEDIA_INTF_T_DVB_BASE + 4)
 263
 264 #define MEDIA_INTF_T_V4L_VIDEO  (MEDIA_INTF_T_V4L_BASE)
 265 #define MEDIA_INTF_T_V4L_VBI    (MEDIA_INTF_T_V4L_BASE + 1)
 266 #define MEDIA_INTF_T_V4L_RADIO  (MEDIA_INTF_T_V4L_BASE + 2)
 267 #define MEDIA_INTF_T_V4L_SUBDEV (MEDIA_INTF_T_V4L_BASE + 3)
 268 #define MEDIA_INTF_T_V4L_SWRADIO (MEDIA_INTF_T_V4L_BASE + 4)
 269
 270 /*
 271  * MC next gen API definitions
 272  *
 273  * NOTE: The declarations below are close to the MC RFC for the Media
 274  *       Controller, the next generation. Yet, there are a few adjustments
 275  *       to do, as we want to be able to have a functional API before
 276  *       the MC properties change. Those will be properly marked below.
 277  *       Please also notice that I removed "num_pads", "num_links",
 278  *       from the proposal, as a proper userspace application will likely
 279  *       use lists for pads/links, just as we intend to do in Kernelspace.
 280  *       The API definition should be freed from fields that are bound to
 281  *       some specific data structure.
 282  *
 283  * FIXME: Currently, I opted to name the new types as "media_v2", as this
 284  *        won't cause any conflict with the Kernelspace namespace, nor with
 285  *        the previous kAPI media_*_desc namespace. This can be changed
 286  *        later, before the adding this API upstream.
 287  */
 288
 289 #if 0 /* Let's postpone it to Kernel 4.6 */
 290 struct media_v2_entity {
 291         __u32 id;
 292         char name[64];          /* FIXME: move to a property? (RFC says so) */
 293         __u32 function;         /* Main function of the entity */
 294         __u16 reserved[12];
 295 };
 296
 297 /* Should match the specific fields at media_intf_devnode */
 298 struct media_v2_intf_devnode {
 299         __u32 major;
 300         __u32 minor;
 301 };
 302
 303 struct media_v2_interface {
 304         __u32 id;
 305         __u32 intf_type;
 306         __u32 flags;
 307         __u32 reserved[9];
 308
 309         union {
 310                 struct media_v2_intf_devnode devnode;
 311                 __u32 raw[16];
 312         };
 313 };
 314
 315 struct media_v2_pad {
 316         __u32 id;
 317         __u32 entity_id;
 318         __u32 flags;
 319         __u16 reserved[9];
 320 };
 321
 322 struct media_v2_link {
 323         __u32 id;
 324         __u32 source_id;
 325         __u32 sink_id;
 326         __u32 flags;
 327         __u32 reserved[5];
 328 };
 329
 330 struct media_v2_topology {
 331         __u64 topology_version;
 332
 333         __u32 num_entities;
 334         __u32 reserved1;
 335         __u64 ptr_entities;
 336
 337         __u32 num_interfaces;
 338         __u32 reserved2;
 339         __u64 ptr_interfaces;
 340
 341         __u32 num_pads;
 342         __u32 reserved3;
 343         __u64 ptr_pads;
 344
 345         __u32 num_links;
 346         __u32 reserved4;
 347         __u64 ptr_links;
 348 };
 349
 350 static inline void __user *media_get_uptr(__u64 arg)
 351 {
 352         return (void __user *)(uintptr_t)arg;
 353 }
 354 #endif
 355
 356 /* ioctls */
 357
 358 #define MEDIA_IOC_DEVICE_INFO           _IOWR('|', 0x00, struct media_device_info)
 359 #define MEDIA_IOC_ENUM_ENTITIES         _IOWR('|', 0x01, struct media_entity_desc)
 360 #define MEDIA_IOC_ENUM_LINKS            _IOWR('|', 0x02, struct media_links_enum)
 361 #define MEDIA_IOC_SETUP_LINK            _IOWR('|', 0x03, struct media_link_desc)
 362
 363 #if 0 /* Let's postpone it to Kernel 4.6 */
 364 #define MEDIA_IOC_G_TOPOLOGY            _IOWR('|', 0x04, struct media_v2_topology)
 365 #endif
 366
 367 #endif /* __LINUX_MEDIA_H */