LXR linux/drivers/media/dvb-core/dvb_ca

   1/*
   2 * dvb_ca.h: generic DVB functions for EN50221 CA interfaces
   3 *
   4 * Copyright (C) 2004 Andrew de Quincey
   5 *
   6 * This program is free software; you can redistribute it and/or
   7 * modify it under the terms of the GNU Lesser General Public License
   8 * as published by the Free Software Foundation; either version 2.1
   9 * of the License, or (at your option) any later version.
  10 *
  11 * This program is distributed in the hope that it will be useful,
  12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 * GNU General Public License for more details.
  15 */
  16
  17#ifndef _DVB_CA_EN50221_H_
  18#define _DVB_CA_EN50221_H_
  19
  20#include <linux/list.h>
  21#include <linux/dvb/ca.h>
  22
  23#include "dvbdev.h"
  24
  25#define DVB_CA_EN50221_POLL_CAM_PRESENT 1
  26#define DVB_CA_EN50221_POLL_CAM_CHANGED 2
  27#define DVB_CA_EN50221_POLL_CAM_READY           4
  28
  29#define DVB_CA_EN50221_FLAG_IRQ_CAMCHANGE       1
  30#define DVB_CA_EN50221_FLAG_IRQ_FR              2
  31#define DVB_CA_EN50221_FLAG_IRQ_DA              4
  32
  33#define DVB_CA_EN50221_CAMCHANGE_REMOVED                0
  34#define DVB_CA_EN50221_CAMCHANGE_INSERTED               1
  35
  36/**
  37 * struct dvb_ca_en50221- Structure describing a CA interface
  38 *
  39 * @owner:              the module owning this structure
  40 * @read_attribute_mem: function for reading attribute memory on the CAM
  41 * @write_attribute_mem: function for writing attribute memory on the CAM
  42 * @read_cam_control:   function for reading the control interface on the CAM
  43 * @write_cam_control:  function for reading the control interface on the CAM
  44 * @slot_reset:         function to reset the CAM slot
  45 * @slot_shutdown:      function to shutdown a CAM slot
  46 * @slot_ts_enable:     function to enable the Transport Stream on a CAM slot
  47 * @poll_slot_status:   function to poll slot status. Only necessary if
  48 *                      DVB_CA_FLAG_EN50221_IRQ_CAMCHANGE is not set.
  49 * @data:               private data, used by caller.
  50 * @private:            Opaque data used by the dvb_ca core. Do not modify!
  51 *
  52 * NOTE: the read_*, write_* and poll_slot_status functions will be
  53 * called for different slots concurrently and need to use locks where
  54 * and if appropriate. There will be no concurrent access to one slot.
  55 */
  56struct dvb_ca_en50221 {
  57        struct module *owner;
  58
  59        int (*read_attribute_mem)(struct dvb_ca_en50221 *ca,
  60                                  int slot, int address);
  61        int (*write_attribute_mem)(struct dvb_ca_en50221 *ca,
  62                                   int slot, int address, u8 value);
  63
  64        int (*read_cam_control)(struct dvb_ca_en50221 *ca,
  65                                int slot, u8 address);
  66        int (*write_cam_control)(struct dvb_ca_en50221 *ca,
  67                                 int slot, u8 address, u8 value);
  68
  69        int (*slot_reset)(struct dvb_ca_en50221 *ca, int slot);
  70        int (*slot_shutdown)(struct dvb_ca_en50221 *ca, int slot);
  71        int (*slot_ts_enable)(struct dvb_ca_en50221 *ca, int slot);
  72
  73        int (*poll_slot_status)(struct dvb_ca_en50221 *ca, int slot, int open);
  74
  75        void *data;
  76
  77        void *private;
  78};
  79
  80/*
  81 * Functions for reporting IRQ events
  82 */
  83
  84/**
  85 * dvb_ca_en50221_camchange_irq - A CAMCHANGE IRQ has occurred.
  86 *
  87 * @pubca: CA instance.
  88 * @slot: Slot concerned.
  89 * @change_type: One of the DVB_CA_CAMCHANGE_* values
  90 */
  91void dvb_ca_en50221_camchange_irq(struct dvb_ca_en50221 *pubca, int slot,
  92                                  int change_type);
  93
  94/**
  95 * dvb_ca_en50221_camready_irq - A CAMREADY IRQ has occurred.
  96 *
  97 * @pubca: CA instance.
  98 * @slot: Slot concerned.
  99 */
 100void dvb_ca_en50221_camready_irq(struct dvb_ca_en50221 *pubca, int slot);
 101
 102/**
 103 * dvb_ca_en50221_frda_irq - An FR or a DA IRQ has occurred.
 104 *
 105 * @ca: CA instance.
 106 * @slot: Slot concerned.
 107 */
 108void dvb_ca_en50221_frda_irq(struct dvb_ca_en50221 *ca, int slot);
 109
 110/*
 111 * Initialisation/shutdown functions
 112 */
 113
 114/**
 115 * dvb_ca_en50221_init - Initialise a new DVB CA device.
 116 *
 117 * @dvb_adapter: DVB adapter to attach the new CA device to.
 118 * @ca: The dvb_ca instance.
 119 * @flags: Flags describing the CA device (DVB_CA_EN50221_FLAG_*).
 120 * @slot_count: Number of slots supported.
 121 *
 122 * @return 0 on success, nonzero on failure
 123 */
 124extern int dvb_ca_en50221_init(struct dvb_adapter *dvb_adapter,
 125                               struct dvb_ca_en50221 *ca, int flags,
 126                               int slot_count);
 127
 128/**
 129 * dvb_ca_en50221_release - Release a DVB CA device.
 130 *
 131 * @ca: The associated dvb_ca instance.
 132 */
 133extern void dvb_ca_en50221_release(struct dvb_ca_en50221 *ca);
 134
 135#endif
 136