2010-10-17 11:40:07 +02:00
|
|
|
/*
|
|
|
|
|
* CCID Passthru Card Device emulation
|
|
|
|
|
*
|
|
|
|
|
* Copyright (c) 2011 Red Hat.
|
|
|
|
|
* Written by Alon Levy.
|
|
|
|
|
*
|
2011-06-26 04:21:35 +02:00
|
|
|
* This code is licensed under the GNU LGPL, version 2 or later.
|
2010-10-17 11:40:07 +02:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef CCID_H
|
|
|
|
|
#define CCID_H
|
|
|
|
|
|
2019-08-12 07:23:51 +02:00
|
|
|
#include "hw/qdev-core.h"
|
2010-10-17 11:40:07 +02:00
|
|
|
|
|
|
|
|
typedef struct CCIDCardState CCIDCardState;
|
|
|
|
|
typedef struct CCIDCardInfo CCIDCardInfo;
|
|
|
|
|
|
2011-12-04 19:34:10 +01:00
|
|
|
#define TYPE_CCID_CARD "ccid-card"
|
|
|
|
|
#define CCID_CARD(obj) \
|
|
|
|
|
OBJECT_CHECK(CCIDCardState, (obj), TYPE_CCID_CARD)
|
|
|
|
|
#define CCID_CARD_CLASS(klass) \
|
|
|
|
|
OBJECT_CLASS_CHECK(CCIDCardClass, (klass), TYPE_CCID_CARD)
|
|
|
|
|
#define CCID_CARD_GET_CLASS(obj) \
|
|
|
|
|
OBJECT_GET_CLASS(CCIDCardClass, (obj), TYPE_CCID_CARD)
|
2010-10-17 11:40:07 +02:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* callbacks to be used by the CCID device (hw/usb-ccid.c) to call
|
|
|
|
|
* into the smartcard device (hw/ccid-card-*.c)
|
|
|
|
|
*/
|
2011-12-04 19:34:10 +01:00
|
|
|
typedef struct CCIDCardClass {
|
2018-01-25 18:14:32 +01:00
|
|
|
/*< private >*/
|
2011-12-04 19:34:10 +01:00
|
|
|
DeviceClass parent_class;
|
2018-01-25 18:14:32 +01:00
|
|
|
/*< public >*/
|
2010-10-17 11:40:07 +02:00
|
|
|
const uint8_t *(*get_atr)(CCIDCardState *card, uint32_t *len);
|
|
|
|
|
void (*apdu_from_guest)(CCIDCardState *card,
|
|
|
|
|
const uint8_t *apdu,
|
|
|
|
|
uint32_t len);
|
2018-01-25 18:14:30 +01:00
|
|
|
void (*realize)(CCIDCardState *card, Error **errp);
|
qdev: Unrealize must not fail
Devices may have component devices and buses.
Device realization may fail. Realization is recursive: a device's
realize() method realizes its components, and device_set_realized()
realizes its buses (which should in turn realize the devices on that
bus, except bus_set_realized() doesn't implement that, yet).
When realization of a component or bus fails, we need to roll back:
unrealize everything we realized so far. If any of these unrealizes
failed, the device would be left in an inconsistent state. Must not
happen.
device_set_realized() lets it happen: it ignores errors in the roll
back code starting at label child_realize_fail.
Since realization is recursive, unrealization must be recursive, too.
But how could a partly failed unrealize be rolled back? We'd have to
re-realize, which can fail. This design is fundamentally broken.
device_set_realized() does not roll back at all. Instead, it keeps
unrealizing, ignoring further errors.
It can screw up even for a device with no buses: if the lone
dc->unrealize() fails, it still unregisters vmstate, and calls
listeners' unrealize() callback.
bus_set_realized() does not roll back either. Instead, it stops
unrealizing.
Fortunately, no unrealize method can fail, as we'll see below.
To fix the design error, drop parameter @errp from all the unrealize
methods.
Any unrealize method that uses @errp now needs an update. This leads
us to unrealize() methods that can fail. Merely passing it to another
unrealize method cannot cause failure, though. Here are the ones that
do other things with @errp:
* virtio_serial_device_unrealize()
Fails when qbus_set_hotplug_handler() fails, but still does all the
other work. On failure, the device would stay realized with its
resources completely gone. Oops. Can't happen, because
qbus_set_hotplug_handler() can't actually fail here. Pass
&error_abort to qbus_set_hotplug_handler() instead.
* hw/ppc/spapr_drc.c's unrealize()
Fails when object_property_del() fails, but all the other work is
already done. On failure, the device would stay realized with its
vmstate registration gone. Oops. Can't happen, because
object_property_del() can't actually fail here. Pass &error_abort
to object_property_del() instead.
* spapr_phb_unrealize()
Fails and bails out when remove_drcs() fails, but other work is
already done. On failure, the device would stay realized with some
of its resources gone. Oops. remove_drcs() fails only when
chassis_from_bus()'s object_property_get_uint() fails, and it can't
here. Pass &error_abort to remove_drcs() instead.
Therefore, no unrealize method can fail before this patch.
device_set_realized()'s recursive unrealization via bus uses
object_property_set_bool(). Can't drop @errp there, so pass
&error_abort.
We similarly unrealize with object_property_set_bool() elsewhere,
always ignoring errors. Pass &error_abort instead.
Several unrealize methods no longer handle errors from other unrealize
methods: virtio_9p_device_unrealize(),
virtio_input_device_unrealize(), scsi_qdev_unrealize(), ...
Much of the deleted error handling looks wrong anyway.
One unrealize methods no longer ignore such errors:
usb_ehci_pci_exit().
Several realize methods no longer ignore errors when rolling back:
v9fs_device_realize_common(), pci_qdev_unrealize(),
spapr_phb_realize(), usb_qdev_realize(), vfio_ccw_realize(),
virtio_device_realize().
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Reviewed-by: Paolo Bonzini <pbonzini@redhat.com>
Message-Id: <20200505152926.18877-17-armbru@redhat.com>
2020-05-05 17:29:24 +02:00
|
|
|
void (*unrealize)(CCIDCardState *card);
|
2011-12-04 19:34:10 +01:00
|
|
|
} CCIDCardClass;
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* state of the CCID Card device (i.e. hw/ccid-card-*.c)
|
|
|
|
|
*/
|
|
|
|
|
struct CCIDCardState {
|
|
|
|
|
DeviceState qdev;
|
|
|
|
|
uint32_t slot; /* For future use with multiple slot reader. */
|
2010-10-17 11:40:07 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* API for smartcard calling the CCID device (used by hw/ccid-card-*.c)
|
|
|
|
|
*/
|
|
|
|
|
void ccid_card_send_apdu_to_guest(CCIDCardState *card,
|
|
|
|
|
uint8_t *apdu,
|
|
|
|
|
uint32_t len);
|
|
|
|
|
void ccid_card_card_removed(CCIDCardState *card);
|
|
|
|
|
void ccid_card_card_inserted(CCIDCardState *card);
|
|
|
|
|
void ccid_card_card_error(CCIDCardState *card, uint64_t error);
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* support guest visible insertion/removal of ccid devices based on actual
|
|
|
|
|
* devices connected/removed. Called by card implementation (passthru, local)
|
|
|
|
|
*/
|
|
|
|
|
int ccid_card_ccid_attach(CCIDCardState *card);
|
|
|
|
|
void ccid_card_ccid_detach(CCIDCardState *card);
|
|
|
|
|
|
|
|
|
|
#endif /* CCID_H */
|