Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 1 | .. -*- coding: utf-8; mode: rst -*- |
| 2 | |
| 3 | .. _ca_data_types: |
| 4 | |
| 5 | ************* |
| 6 | CA Data Types |
| 7 | ************* |
| 8 | |
| 9 | |
Mauro Carvalho Chehab | e8be7e9 | 2016-08-29 17:37:59 -0300 | [diff] [blame] | 10 | .. c:type:: ca_slot_info |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 11 | |
| 12 | ca_slot_info_t |
| 13 | ============== |
| 14 | |
| 15 | |
| 16 | .. code-block:: c |
| 17 | |
| 18 | typedef struct ca_slot_info { |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 19 | int num; /* slot number */ |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 20 | |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 21 | int type; /* CA interface this slot supports */ |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 22 | #define CA_CI 1 /* CI high level interface */ |
| 23 | #define CA_CI_LINK 2 /* CI link layer level interface */ |
| 24 | #define CA_CI_PHYS 4 /* CI physical layer level interface */ |
| 25 | #define CA_DESCR 8 /* built-in descrambler */ |
| 26 | #define CA_SC 128 /* simple smart card interface */ |
| 27 | |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 28 | unsigned int flags; |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 29 | #define CA_CI_MODULE_PRESENT 1 /* module (or card) inserted */ |
| 30 | #define CA_CI_MODULE_READY 2 |
| 31 | } ca_slot_info_t; |
| 32 | |
| 33 | |
Mauro Carvalho Chehab | e8be7e9 | 2016-08-29 17:37:59 -0300 | [diff] [blame] | 34 | .. c:type:: ca_descr_info |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 35 | |
| 36 | ca_descr_info_t |
| 37 | =============== |
| 38 | |
| 39 | |
| 40 | .. code-block:: c |
| 41 | |
| 42 | typedef struct ca_descr_info { |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 43 | unsigned int num; /* number of available descramblers (keys) */ |
| 44 | unsigned int type; /* type of supported scrambling system */ |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 45 | #define CA_ECD 1 |
| 46 | #define CA_NDS 2 |
| 47 | #define CA_DSS 4 |
| 48 | } ca_descr_info_t; |
| 49 | |
| 50 | |
Mauro Carvalho Chehab | e8be7e9 | 2016-08-29 17:37:59 -0300 | [diff] [blame] | 51 | .. c:type:: ca_caps |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 52 | |
| 53 | ca_caps_t |
| 54 | ========= |
| 55 | |
| 56 | |
| 57 | .. code-block:: c |
| 58 | |
| 59 | typedef struct ca_caps { |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 60 | unsigned int slot_num; /* total number of CA card and module slots */ |
| 61 | unsigned int slot_type; /* OR of all supported types */ |
| 62 | unsigned int descr_num; /* total number of descrambler slots (keys) */ |
| 63 | unsigned int descr_type;/* OR of all supported types */ |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 64 | } ca_cap_t; |
| 65 | |
| 66 | |
Mauro Carvalho Chehab | e8be7e9 | 2016-08-29 17:37:59 -0300 | [diff] [blame] | 67 | .. c:type:: ca_msg |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 68 | |
| 69 | ca_msg_t |
| 70 | ======== |
| 71 | |
| 72 | |
| 73 | .. code-block:: c |
| 74 | |
| 75 | /* a message to/from a CI-CAM */ |
| 76 | typedef struct ca_msg { |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 77 | unsigned int index; |
| 78 | unsigned int type; |
| 79 | unsigned int length; |
Mauro Carvalho Chehab | 8968da9 | 2016-07-13 08:43:30 -0300 | [diff] [blame] | 80 | unsigned char msg[256]; |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 81 | } ca_msg_t; |
| 82 | |
| 83 | |
Mauro Carvalho Chehab | e8be7e9 | 2016-08-29 17:37:59 -0300 | [diff] [blame] | 84 | .. c:type:: ca_descr |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 85 | |
| 86 | ca_descr_t |
| 87 | ========== |
| 88 | |
| 89 | |
| 90 | .. code-block:: c |
| 91 | |
| 92 | typedef struct ca_descr { |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 93 | unsigned int index; |
| 94 | unsigned int parity; |
Mauro Carvalho Chehab | 8968da9 | 2016-07-13 08:43:30 -0300 | [diff] [blame] | 95 | unsigned char cw[8]; |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 96 | } ca_descr_t; |
| 97 | |
| 98 | |
Mauro Carvalho Chehab | e8be7e9 | 2016-08-29 17:37:59 -0300 | [diff] [blame] | 99 | .. c:type:: ca_pid |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 100 | |
| 101 | ca-pid |
| 102 | ====== |
| 103 | |
| 104 | |
| 105 | .. code-block:: c |
| 106 | |
| 107 | typedef struct ca_pid { |
Mauro Carvalho Chehab | 0579e6e | 2016-07-04 16:25:48 -0300 | [diff] [blame] | 108 | unsigned int pid; |
| 109 | int index; /* -1 == disable*/ |
Markus Heiser | 5377d91 | 2016-06-30 15:18:56 +0200 | [diff] [blame] | 110 | } ca_pid_t; |