Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 1 | #pragma once |
| 2 | #include <stdbool.h> |
| 3 | #include <stdint.h> |
| 4 | |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 5 | #include "ccid_proto.h" |
Harald Welte | 0634836 | 2019-05-19 00:45:17 +0200 | [diff] [blame] | 6 | #include "logging.h" |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 7 | |
| 8 | #define NR_SLOTS 8 |
| 9 | |
| 10 | #define LOGPCI(ci, lvl, fmt, args ...) LOGP(DCCID, lvl, "%s: " fmt, (ci)->name, ## args) |
| 11 | #define LOGPCS(cs, lvl, fmt, args ...) \ |
Harald Welte | e73a1df | 2019-05-15 22:27:02 +0200 | [diff] [blame] | 12 | LOGP(DCCID, lvl, "%s(%u): " fmt, (cs)->ci->name, (cs)->slot_nr, ## args) |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 13 | |
| 14 | struct msgb; |
| 15 | |
| 16 | struct ccid_pars_decoded { |
| 17 | /* global for T0/T1 */ |
Harald Welte | 860d006 | 2019-05-18 11:18:39 +0200 | [diff] [blame] | 18 | uint32_t fi; |
| 19 | uint32_t di; |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 20 | enum ccid_clock_stop clock_stop; |
| 21 | bool inverse_convention; |
| 22 | |
| 23 | struct { |
| 24 | uint8_t guard_time_etu; |
| 25 | uint8_t waiting_integer; |
| 26 | } t0; |
| 27 | |
| 28 | struct { |
| 29 | enum ccid_t1_csum_type csum_type; |
| 30 | uint8_t guard_time_t1; |
| 31 | uint8_t bwi; |
| 32 | uint8_t cwi; |
| 33 | uint8_t ifsc; |
| 34 | uint8_t nad; |
| 35 | } t1; |
| 36 | }; |
| 37 | |
| 38 | struct ccid_slot { |
| 39 | /* back-pointer to the ccid_instance */ |
| 40 | struct ccid_instance *ci; |
| 41 | /* number of this slot (0 = first) */ |
| 42 | uint8_t slot_nr; |
| 43 | /* is there an ICC physically present (card detect)? */ |
| 44 | bool icc_present; |
| 45 | /* was there an ICC present during the last NotifSlotStatus? |
| 46 | * should be set to zero every USB resume and setConfig != 0 */ |
| 47 | bool icc_present_last; |
| 48 | /* is the ICC physically powered? */ |
| 49 | bool icc_powered; |
| 50 | /* is the ICC currently in reset? */ |
| 51 | bool icc_in_reset; |
| 52 | /* is this slot currently busy with processing a CCID command? */ |
| 53 | bool cmd_busy; |
| 54 | /* decided CCID parameters */ |
| 55 | struct ccid_pars_decoded pars; |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 56 | /* default parameters; applied on ResetParameters */ |
| 57 | const struct ccid_pars_decoded *default_pars; |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 58 | }; |
| 59 | |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 60 | /* CCID operations provided by USB transport layer */ |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 61 | struct ccid_ops { |
Harald Welte | e6ac416 | 2019-05-16 11:18:00 +0200 | [diff] [blame] | 62 | /* msgb ownership in below functions is transferred, i.e. whoever |
| 63 | * provides the callback function must make sure to msgb_free() them |
| 64 | * once transmission on IN or INT EP has completed. */ |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 65 | int (*send_in)(struct ccid_instance *ci, struct msgb *msg); |
Harald Welte | a7da504 | 2019-05-16 11:08:35 +0200 | [diff] [blame] | 66 | int (*send_int)(struct ccid_instance *ci, struct msgb *msg); |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 67 | }; |
| 68 | |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 69 | /* CCID operations provided by actual slot hardware */ |
| 70 | struct ccid_slot_ops { |
| 71 | /* called once on start-up for initialization */ |
| 72 | int (*init)(struct ccid_slot *cs); |
| 73 | /* called before processing any command for a slot; used e.g. to |
| 74 | * update the (power/clock/...) status from the hardware */ |
| 75 | void (*pre_proc_cb)(struct ccid_slot *cs, struct msgb *msg); |
| 76 | |
Harald Welte | 505d441 | 2019-05-16 17:26:09 +0200 | [diff] [blame] | 77 | void (*icc_power_on_async)(struct ccid_slot *cs, struct msgb *msg, |
| 78 | const struct ccid_pc_to_rdr_icc_power_on *ipo); |
| 79 | void (*xfr_block_async)(struct ccid_slot *cs, struct msgb *msg, |
| 80 | const struct ccid_pc_to_rdr_xfr_block *xfb); |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 81 | void (*set_power)(struct ccid_slot *cs, bool enable); |
| 82 | void (*set_clock)(struct ccid_slot *cs, enum ccid_clock_command cmd); |
| 83 | int (*set_params)(struct ccid_slot *cs, enum ccid_protocol_num proto, |
| 84 | const struct ccid_pars_decoded *pars_dec); |
| 85 | int (*set_rate_and_clock)(struct ccid_slot *cs, uint32_t freq_hz, uint32_t rate_bps); |
| 86 | }; |
| 87 | |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 88 | /* An instance of CCID (i.e. a card reader device) */ |
| 89 | struct ccid_instance { |
| 90 | /* slots within the reader */ |
| 91 | struct ccid_slot slot[NR_SLOTS]; |
| 92 | /* set of function pointers implementing specific operations */ |
Harald Welte | bcbc197 | 2019-05-15 21:57:32 +0200 | [diff] [blame] | 93 | const struct ccid_ops *ops; |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 94 | const struct ccid_slot_ops *slot_ops; |
Harald Welte | 6982fab | 2019-05-16 23:01:35 +0200 | [diff] [blame] | 95 | /* USB CCID Class Specific Descriptor */ |
| 96 | const struct usb_ccid_class_descriptor *class_desc; |
| 97 | /* array of permitted data rates; length: bNumDataRatesSupported */ |
| 98 | const uint32_t *data_rates; |
| 99 | /* array of permitted clock frequencies; length: bNumClockSupported */ |
| 100 | const uint32_t *clock_freqs; |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 101 | const char *name; |
Harald Welte | bcbc197 | 2019-05-15 21:57:32 +0200 | [diff] [blame] | 102 | /* user-supplied opaque data */ |
| 103 | void *priv; |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 104 | }; |
| 105 | |
Harald Welte | 005b09d | 2019-05-16 17:24:29 +0200 | [diff] [blame] | 106 | int ccid_slot_send(struct ccid_slot *cs, struct msgb *msg); |
| 107 | int ccid_slot_send_unbusy(struct ccid_slot *cs, struct msgb *msg); |
| 108 | struct msgb *ccid_gen_slot_status(struct ccid_slot *cs, uint8_t seq, uint8_t cmd_sts, |
| 109 | enum ccid_error_code err); |
| 110 | |
| 111 | struct msgb *ccid_gen_data_block(struct ccid_slot *cs, uint8_t seq, uint8_t cmd_sts, |
| 112 | enum ccid_error_code err, const uint8_t *data, |
| 113 | uint32_t data_len); |
| 114 | |
Harald Welte | cab5d15 | 2019-05-16 13:31:16 +0200 | [diff] [blame] | 115 | void ccid_instance_init(struct ccid_instance *ci, const struct ccid_ops *ops, |
Harald Welte | 6982fab | 2019-05-16 23:01:35 +0200 | [diff] [blame] | 116 | const struct ccid_slot_ops *slot_ops, |
| 117 | const struct usb_ccid_class_descriptor *class_desc, |
| 118 | const uint32_t *data_rates, const uint32_t *clock_freqs, |
| 119 | const char *name, void *priv); |
Harald Welte | 8d186ad | 2019-05-15 19:40:29 +0200 | [diff] [blame] | 120 | int ccid_handle_out(struct ccid_instance *ci, struct msgb *msg); |
Harald Welte | 6982fab | 2019-05-16 23:01:35 +0200 | [diff] [blame] | 121 | |
| 122 | /* Invalid request received: Please return STALL */ |
| 123 | #define CCID_CTRL_RET_INVALID -1 |
| 124 | /* Unknown request received: Not something CCID is supposed to handle */ |
| 125 | #define CCID_CTRL_RET_UNKNOWN 0 |
| 126 | /* Request OK. In case of a CTRL-IN: continue by sending wLength bytes to host */ |
| 127 | #define CCID_CTRL_RET_OK 1 |
| 128 | |
| 129 | int ccid_handle_ctrl(struct ccid_instance *ci, const uint8_t *ctrl_req, const uint8_t **data_in); |