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