ftp://ftp.kernel.org/pub/linux/kernel/v2.6/linux-2.6.6.tar.bz2
[linux-2.6.git] / drivers / media / dvb / 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 /* Structure describing a CA interface */
43 struct dvb_ca_en50221 {
44
45         /* functions for accessing attribute memory on the CAM */
46         int (*read_attribute_mem)(struct dvb_ca_en50221* ca, int slot, int address);
47         int (*write_attribute_mem)(struct dvb_ca_en50221* ca, int slot, int address, u8 value);
48
49         /* functions for accessing the control interface on the CAM */
50         int (*read_cam_control)(struct dvb_ca_en50221* ca, int slot, u8 address);
51         int (*write_cam_control)(struct dvb_ca_en50221* ca, int slot, u8 address, u8 value);
52
53         /* Functions for controlling slots */
54         int (*slot_reset)(struct dvb_ca_en50221* ca, int slot);
55         int (*slot_shutdown)(struct dvb_ca_en50221* ca, int slot);
56         int (*slot_ts_enable)(struct dvb_ca_en50221* ca, int slot);
57
58         /*
59         * Poll slot status.
60         * Only necessary if DVB_CA_FLAG_EN50221_IRQ_CAMCHANGE is not set
61         */
62         int (*poll_slot_status)(struct dvb_ca_en50221* ca, int slot);
63
64         /* private data, used by caller */
65         void* data;
66
67         /* Opaque data used by the dvb_ca core. Do not modify! */
68         void* private;
69 };
70
71
72
73
74 /* ******************************************************************************** */
75 /* Functions for reporting IRQ events */
76
77 /**
78  * A CAMCHANGE IRQ has occurred.
79  *
80  * @param ca CA instance.
81  * @param slot Slot concerned.
82  * @param change_type One of the DVB_CA_CAMCHANGE_* values
83  */
84 void dvb_ca_en50221_camchange_irq(struct dvb_ca_en50221* pubca, int slot, int change_type);
85
86 /**
87  * A CAMREADY IRQ has occurred.
88  *
89  * @param ca CA instance.
90  * @param slot Slot concerned.
91  */
92 void dvb_ca_en50221_camready_irq(struct dvb_ca_en50221* pubca, int slot);
93
94 /**
95  * An FR or a DA IRQ has occurred.
96  *
97  * @param ca CA instance.
98  * @param slot Slot concerned.
99  */
100 void dvb_ca_en50221_frda_irq(struct dvb_ca_en50221* ca, int slot);
101
102
103
104 /* ******************************************************************************** */
105 /* Initialisation/shutdown functions */
106
107 /**
108  * Initialise a new DVB CA device.
109  *
110  * @param dvb_adapter DVB adapter to attach the new CA device to.
111  * @param ca The dvb_ca instance.
112  * @param flags Flags describing the CA device (DVB_CA_EN50221_FLAG_*).
113  * @param slot_count Number of slots supported.
114  *
115  * @return 0 on success, nonzero on failure
116  */
117 extern int dvb_ca_en50221_init(struct dvb_adapter *dvb_adapter, struct dvb_ca_en50221* ca, int flags, int slot_count);
118
119 /**
120  * Release a DVB CA device.
121  *
122  * @param ca The associated dvb_ca instance.
123  */
124 extern void dvb_ca_en50221_release(struct dvb_ca_en50221* ca);
125
126
127
128 #endif