include/uapi/linux/media.h

   1 /*
   2  * Multimedia device API
   3  *
   4  * Copyright (C) 2010 Nokia Corporation
   5  *
   6  * Contacts: Laurent Pinchart <[email protected]>
   7  *           Sakari Ailus <[email protected]>
   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  * I/O entities
  76  */
  77 #define MEDIA_ENT_F_IO_DTV              (MEDIA_ENT_F_BASE + 1001)
  78 #define MEDIA_ENT_F_IO_VBI              (MEDIA_ENT_F_BASE + 1002)
  79 #define MEDIA_ENT_F_IO_SWRADIO          (MEDIA_ENT_F_BASE + 1003)
  80
  81 /*
  82  * Analog TV IF-PLL decoders
  83  *
  84  * It is a responsibility of the master/bridge drivers to create links
  85  * for MEDIA_ENT_F_IF_VID_DECODER and MEDIA_ENT_F_IF_AUD_DECODER.
  86  */
  87 #define MEDIA_ENT_F_IF_VID_DECODER      (MEDIA_ENT_F_BASE + 2001)
  88 #define MEDIA_ENT_F_IF_AUD_DECODER      (MEDIA_ENT_F_BASE + 2002)
  89
  90 /*
  91  * Connectors
  92  */
  93 /* It is a responsibility of the entity drivers to add connectors and links */
  94 #define MEDIA_ENT_F_CONN_RF             (MEDIA_ENT_F_BASE + 10001)
  95 #define MEDIA_ENT_F_CONN_SVIDEO         (MEDIA_ENT_F_BASE + 10002)
  96 #define MEDIA_ENT_F_CONN_COMPOSITE      (MEDIA_ENT_F_BASE + 10003)
  97
  98 /*
  99  * Don't touch on those. The ranges MEDIA_ENT_F_OLD_BASE and
 100  * MEDIA_ENT_F_OLD_SUBDEV_BASE are kept to keep backward compatibility
 101  * with the legacy v1 API.The number range is out of range by purpose:
 102  * several previously reserved numbers got excluded from this range.
 103  *
 104  * Subdevs are initialized with MEDIA_ENT_T_V4L2_SUBDEV_UNKNOWN,
 105  * in order to preserve backward compatibility.
 106  * Drivers must change to the proper subdev type before
 107  * registering the entity.
 108  */
 109
 110 #define MEDIA_ENT_F_IO_V4L              (MEDIA_ENT_F_OLD_BASE + 1)
 111
 112 #define MEDIA_ENT_F_CAM_SENSOR          (MEDIA_ENT_F_OLD_SUBDEV_BASE + 1)
 113 #define MEDIA_ENT_F_FLASH               (MEDIA_ENT_F_OLD_SUBDEV_BASE + 2)
 114 #define MEDIA_ENT_F_LENS                (MEDIA_ENT_F_OLD_SUBDEV_BASE + 3)
 115 #define MEDIA_ENT_F_ATV_DECODER         (MEDIA_ENT_F_OLD_SUBDEV_BASE + 4)
 116 /*
 117  * It is a responsibility of the master/bridge drivers to add connectors
 118  * and links for MEDIA_ENT_F_TUNER. Please notice that some old tuners
 119  * may require the usage of separate I2C chips to decode analog TV signals,
 120  * when the master/bridge chipset doesn't have its own TV standard decoder.
 121  * On such cases, the IF-PLL staging is mapped via one or two entities:
 122  * MEDIA_ENT_F_IF_VID_DECODER and/or MEDIA_ENT_F_IF_AUD_DECODER.
 123  */
 124 #define MEDIA_ENT_F_TUNER               (MEDIA_ENT_F_OLD_SUBDEV_BASE + 5)
 125
 126 #define MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN MEDIA_ENT_F_OLD_SUBDEV_BASE
 127
 128 #ifndef __KERNEL__
 129
 130 /*
 131  * Legacy symbols used to avoid userspace compilation breakages
 132  *
 133  * Those symbols map the entity function into types and should be
 134  * used only on legacy programs for legacy hardware. Don't rely
 135  * on those for MEDIA_IOC_G_TOPOLOGY.
 136  */
 137 #define MEDIA_ENT_TYPE_SHIFT            16
 138 #define MEDIA_ENT_TYPE_MASK             0x00ff0000
 139 #define MEDIA_ENT_SUBTYPE_MASK          0x0000ffff
 140
 141 #define MEDIA_ENT_T_DEVNODE             MEDIA_ENT_F_OLD_BASE
 142 #define MEDIA_ENT_T_DEVNODE_V4L         MEDIA_ENT_F_IO_V4L
 143 #define MEDIA_ENT_T_DEVNODE_FB          (MEDIA_ENT_T_DEVNODE + 2)
 144 #define MEDIA_ENT_T_DEVNODE_ALSA        (MEDIA_ENT_T_DEVNODE + 3)
 145 #define MEDIA_ENT_T_DEVNODE_DVB         (MEDIA_ENT_T_DEVNODE + 4)
 146
 147 #define MEDIA_ENT_T_UNKNOWN             MEDIA_ENT_F_UNKNOWN
 148 #define MEDIA_ENT_T_V4L2_VIDEO          MEDIA_ENT_F_IO_V4L
 149 #define MEDIA_ENT_T_V4L2_SUBDEV         MEDIA_ENT_F_V4L2_SUBDEV_UNKNOWN
 150 #define MEDIA_ENT_T_V4L2_SUBDEV_SENSOR  MEDIA_ENT_F_CAM_SENSOR
 151 #define MEDIA_ENT_T_V4L2_SUBDEV_FLASH   MEDIA_ENT_F_FLASH
 152 #define MEDIA_ENT_T_V4L2_SUBDEV_LENS    MEDIA_ENT_F_LENS
 153 #define MEDIA_ENT_T_V4L2_SUBDEV_DECODER MEDIA_ENT_F_ATV_DECODER
 154 #define MEDIA_ENT_T_V4L2_SUBDEV_TUNER   MEDIA_ENT_F_TUNER
 155 #endif
 156
 157 /* Entity flags */
 158 #define MEDIA_ENT_FL_DEFAULT            (1 << 0)
 159 #define MEDIA_ENT_FL_CONNECTOR          (1 << 1)
 160
 161 struct media_entity_desc {
 162         __u32 id;
 163         char name[32];
 164         __u32 type;
 165         __u32 revision;
 166         __u32 flags;
 167         __u32 group_id;
 168         __u16 pads;
 169         __u16 links;
 170
 171         __u32 reserved[4];
 172
 173         union {
 174                 /* Node specifications */
 175                 struct {
 176                         __u32 major;
 177                         __u32 minor;
 178                 } dev;
 179
 180 #if 1
 181                 /*
 182                  * TODO: this shouldn't have been added without
 183                  * actual drivers that use this. When the first real driver
 184                  * appears that sets this information, special attention
 185                  * should be given whether this information is 1) enough, and
 186                  * 2) can deal with udev rules that rename devices. The struct
 187                  * dev would not be sufficient for this since that does not
 188                  * contain the subdevice information. In addition, struct dev
 189                  * can only refer to a single device, and not to multiple (e.g.
 190                  * pcm and mixer devices).
 191                  *
 192                  * So for now mark this as a to do.
 193                  */
 194                 struct {
 195                         __u32 card;
 196                         __u32 device;
 197                         __u32 subdevice;
 198                 } alsa;
 199 #endif
 200
 201 #if 1
 202                 /*
 203                  * DEPRECATED: previous node specifications. Kept just to
 204                  * avoid breaking compilation, but media_entity_desc.dev
 205                  * should be used instead. In particular, alsa and dvb
 206                  * fields below are wrong: for all devnodes, there should
 207                  * be just major/minor inside the struct, as this is enough
 208                  * to represent any devnode, no matter what type.
 209                  */
 210                 struct {
 211                         __u32 major;
 212                         __u32 minor;
 213                 } v4l;
 214                 struct {
 215                         __u32 major;
 216                         __u32 minor;
 217                 } fb;
 218                 int dvb;
 219 #endif
 220
 221                 /* Sub-device specifications */
 222                 /* Nothing needed yet */
 223                 __u8 raw[184];
 224         };
 225 };
 226
 227 #define MEDIA_PAD_FL_SINK               (1 << 0)
 228 #define MEDIA_PAD_FL_SOURCE             (1 << 1)
 229 #define MEDIA_PAD_FL_MUST_CONNECT       (1 << 2)
 230
 231 struct media_pad_desc {
 232         __u32 entity;           /* entity ID */
 233         __u16 index;            /* pad index */
 234         __u32 flags;            /* pad flags */
 235         __u32 reserved[2];
 236 };
 237
 238 #define MEDIA_LNK_FL_ENABLED            (1 << 0)
 239 #define MEDIA_LNK_FL_IMMUTABLE          (1 << 1)
 240 #define MEDIA_LNK_FL_DYNAMIC            (1 << 2)
 241
 242 #define MEDIA_LNK_FL_LINK_TYPE          (0xf << 28)
 243 #  define MEDIA_LNK_FL_DATA_LINK        (0 << 28)
 244 #  define MEDIA_LNK_FL_INTERFACE_LINK   (1 << 28)
 245
 246 struct media_link_desc {
 247         struct media_pad_desc source;
 248         struct media_pad_desc sink;
 249         __u32 flags;
 250         __u32 reserved[2];
 251 };
 252
 253 struct media_links_enum {
 254         __u32 entity;
 255         /* Should have enough room for pads elements */
 256         struct media_pad_desc __user *pads;
 257         /* Should have enough room for links elements */
 258         struct media_link_desc __user *links;
 259         __u32 reserved[4];
 260 };
 261
 262 /* Interface type ranges */
 263
 264 #define MEDIA_INTF_T_DVB_BASE   0x00000100
 265 #define MEDIA_INTF_T_V4L_BASE   0x00000200
 266
 267 /* Interface types */
 268
 269 #define MEDIA_INTF_T_DVB_FE     (MEDIA_INTF_T_DVB_BASE)
 270 #define MEDIA_INTF_T_DVB_DEMUX  (MEDIA_INTF_T_DVB_BASE + 1)
 271 #define MEDIA_INTF_T_DVB_DVR    (MEDIA_INTF_T_DVB_BASE + 2)
 272 #define MEDIA_INTF_T_DVB_CA     (MEDIA_INTF_T_DVB_BASE + 3)
 273 #define MEDIA_INTF_T_DVB_NET    (MEDIA_INTF_T_DVB_BASE + 4)
 274
 275 #define MEDIA_INTF_T_V4L_VIDEO  (MEDIA_INTF_T_V4L_BASE)
 276 #define MEDIA_INTF_T_V4L_VBI    (MEDIA_INTF_T_V4L_BASE + 1)
 277 #define MEDIA_INTF_T_V4L_RADIO  (MEDIA_INTF_T_V4L_BASE + 2)
 278 #define MEDIA_INTF_T_V4L_SUBDEV (MEDIA_INTF_T_V4L_BASE + 3)
 279 #define MEDIA_INTF_T_V4L_SWRADIO (MEDIA_INTF_T_V4L_BASE + 4)
 280
 281 /*
 282  * MC next gen API definitions
 283  *
 284  * NOTE: The declarations below are close to the MC RFC for the Media
 285  *       Controller, the next generation. Yet, there are a few adjustments
 286  *       to do, as we want to be able to have a functional API before
 287  *       the MC properties change. Those will be properly marked below.
 288  *       Please also notice that I removed "num_pads", "num_links",
 289  *       from the proposal, as a proper userspace application will likely
 290  *       use lists for pads/links, just as we intend to do in Kernelspace.
 291  *       The API definition should be freed from fields that are bound to
 292  *       some specific data structure.
 293  *
 294  * FIXME: Currently, I opted to name the new types as "media_v2", as this
 295  *        won't cause any conflict with the Kernelspace namespace, nor with
 296  *        the previous kAPI media_*_desc namespace. This can be changed
 297  *        later, before the adding this API upstream.
 298  */
 299
 300
 301 struct media_v2_entity {
 302         __u32 id;
 303         char name[64];          /* FIXME: move to a property? (RFC says so) */
 304         __u32 function;         /* Main function of the entity */
 305         __u16 reserved[12];
 306 };
 307
 308 /* Should match the specific fields at media_intf_devnode */
 309 struct media_v2_intf_devnode {
 310         __u32 major;
 311         __u32 minor;
 312 };
 313
 314 struct media_v2_interface {
 315         __u32 id;
 316         __u32 intf_type;
 317         __u32 flags;
 318         __u32 reserved[9];
 319
 320         union {
 321                 struct media_v2_intf_devnode devnode;
 322                 __u32 raw[16];
 323         };
 324 };
 325
 326 struct media_v2_pad {
 327         __u32 id;
 328         __u32 entity_id;
 329         __u32 flags;
 330         __u16 reserved[9];
 331 };
 332
 333 struct media_v2_link {
 334         __u32 id;
 335         __u32 source_id;
 336         __u32 sink_id;
 337         __u32 flags;
 338         __u32 reserved[5];
 339 };
 340
 341 struct media_v2_topology {
 342         __u64 topology_version;
 343
 344         __u32 num_entities;
 345         __u32 reserved1;
 346         __u64 ptr_entities;
 347
 348         __u32 num_interfaces;
 349         __u32 reserved2;
 350         __u64 ptr_interfaces;
 351
 352         __u32 num_pads;
 353         __u32 reserved3;
 354         __u64 ptr_pads;
 355
 356         __u32 num_links;
 357         __u32 reserved4;
 358         __u64 ptr_links;
 359 };
 360
 361 static inline void __user *media_get_uptr(__u64 arg)
 362 {
 363         return (void __user *)(uintptr_t)arg;
 364 }
 365
 366 /* ioctls */
 367
 368 #define MEDIA_IOC_DEVICE_INFO           _IOWR('|', 0x00, struct media_device_info)
 369 #define MEDIA_IOC_ENUM_ENTITIES         _IOWR('|', 0x01, struct media_entity_desc)
 370 #define MEDIA_IOC_ENUM_LINKS            _IOWR('|', 0x02, struct media_links_enum)
 371 #define MEDIA_IOC_SETUP_LINK            _IOWR('|', 0x03, struct media_link_desc)
 372 #define MEDIA_IOC_G_TOPOLOGY            _IOWR('|', 0x04, struct media_v2_topology)
 373
 374 #endif /* __LINUX_MEDIA_H */