drivers/media/dvb-core/dvb_ca_en50221.h

   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  * You should have received a copy of the GNU Lesser General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19  */
  20
  21 #ifndef _DVB_CA_EN50221_H_
  22 #define _DVB_CA_EN50221_H_
  23
  24 #include <linux/list.h>
  25 #include <linux/dvb/ca.h>
  26
  27 #include "dvbdev.h"
  28
  29 #define DVB_CA_EN50221_POLL_CAM_PRESENT 1
  30 #define DVB_CA_EN50221_POLL_CAM_CHANGED 2
  31 #define DVB_CA_EN50221_POLL_CAM_READY           4
  32
  33 #define DVB_CA_EN50221_FLAG_IRQ_CAMCHANGE       1
  34 #define DVB_CA_EN50221_FLAG_IRQ_FR              2
  35 #define DVB_CA_EN50221_FLAG_IRQ_DA              4
  36
  37 #define DVB_CA_EN50221_CAMCHANGE_REMOVED                0
  38 #define DVB_CA_EN50221_CAMCHANGE_INSERTED               1
  39
  40
  41
  42 /**
  43  * struct dvb_ca_en50221- Structure describing a CA interface
  44  *
  45  * @owner:              the module owning this structure
  46  * @read_attribute_mem: function for reading attribute memory on the CAM
  47  * @write_attribute_mem: function for writing attribute memory on the CAM
  48  * @read_cam_control:   function for reading the control interface on the CAM
  49  * @write_cam_control:  function for reading the control interface on the CAM
  50  * @slot_reset:         function to reset the CAM slot
  51  * @slot_shutdown:      function to shutdown a CAM slot
  52  * @slot_ts_enable:     function to enable the Transport Stream on a CAM slot
  53  * @poll_slot_status:   function to poll slot status. Only necessary if
  54  *                      DVB_CA_FLAG_EN50221_IRQ_CAMCHANGE is not set.
  55  * @data:               private data, used by caller.
  56  * @private:            Opaque data used by the dvb_ca core. Do not modify!
  57  *
  58  * NOTE: the read_*, write_* and poll_slot_status functions will be
  59  * called for different slots concurrently and need to use locks where
  60  * and if appropriate. There will be no concurrent access to one slot.
  61  */
  62 struct dvb_ca_en50221 {
  63
  64
  65
  66         int (*write_attribute_mem)(struct dvb_ca_en50221* ca, int slot, int address, u8 value);
  67
  68         int (*read_cam_control)(struct dvb_ca_en50221* ca, int slot, u8 address);
  69         int (*write_cam_control)(struct dvb_ca_en50221* ca, int slot, u8 address, u8 value);
  70
  71         int (*slot_reset)(struct dvb_ca_en50221* ca, int slot);
  72         int (*slot_shutdown)(struct dvb_ca_en50221* ca, int slot);
  73         int (*slot_ts_enable)(struct dvb_ca_en50221* ca, int slot);
  74
  75         int (*poll_slot_status)(struct dvb_ca_en50221* ca, int slot, int open);
  76
  77         void* data;
  78
  79         void* private;
  80 };
  81
  82
  83
  84
  85 /* ******************************************************************************** */
  86 /* Functions for reporting IRQ events */
  87
  88 /**
  89  * dvb_ca_en50221_camchange_irq - A CAMCHANGE IRQ has occurred.
  90  *
  91  * @pubca: CA instance.
  92  * @slot: Slot concerned.
  93  * @change_type: One of the DVB_CA_CAMCHANGE_* values
  94  */
  95 void dvb_ca_en50221_camchange_irq(struct dvb_ca_en50221* pubca, int slot, int change_type);
  96
  97 /**
  98  * dvb_ca_en50221_camready_irq - A CAMREADY IRQ has occurred.
  99  *
 100  * @pubca: CA instance.
 101  * @slot: Slot concerned.
 102  */
 103 void dvb_ca_en50221_camready_irq(struct dvb_ca_en50221* pubca, int slot);
 104
 105 /**
 106  * dvb_ca_en50221_frda_irq - An FR or a DA IRQ has occurred.
 107  *
 108  * @ca: CA instance.
 109  * @slot: Slot concerned.
 110  */
 111 void dvb_ca_en50221_frda_irq(struct dvb_ca_en50221* ca, int slot);
 112
 113
 114
 115 /* ******************************************************************************** */
 116 /* Initialisation/shutdown functions */
 117
 118 /**
 119  * dvb_ca_en50221_init - Initialise a new DVB CA device.
 120  *
 121  * @dvb_adapter: DVB adapter to attach the new CA device to.
 122  * @ca: The dvb_ca instance.
 123  * @flags: Flags describing the CA device (DVB_CA_EN50221_FLAG_*).
 124  * @slot_count: Number of slots supported.
 125  *
 126  * @return 0 on success, nonzero on failure
 127  */
 128 extern int dvb_ca_en50221_init(struct dvb_adapter *dvb_adapter, struct dvb_ca_en50221* ca, int flags, int slot_count);
 129
 130 /**
 131  * dvb_ca_en50221_release - Release a DVB CA device.
 132  *
 133  * @ca: The associated dvb_ca instance.
 134  */
 135 extern void dvb_ca_en50221_release(struct dvb_ca_en50221* ca);
 136
 137
 138
 139 #endif