sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget*/translations/zh_CN/arch/s390/driver-modelmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/zh_TW/arch/s390/driver-modelmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/it_IT/arch/s390/driver-modelmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/ja_JP/arch/s390/driver-modelmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/ko_KR/arch/s390/driver-modelmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/pt_BR/arch/s390/driver-modelmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget*/translations/sp_SP/arch/s390/driver-modelmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(hS/390 driver model interfacesh]hS/390 driver model interfaces}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhD/var/lib/git/docbuild/linux/Documentation/arch/s390/driver-model.rsthKubh)}(hhh](h)}(h1. CCW devicesh]h1. CCW devices}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh paragraph)}(h{All devices which can be addressed by means of ccws are called 'CCW devices' - even if they aren't actually driven by ccws.h]hAll devices which can be addressed by means of ccws are called ‘CCW devices’ - even if they aren’t actually driven by ccws.}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hcAll ccw devices are accessed via a subchannel, this is reflected in the structures under devices/::h]hbAll ccw devices are accessed via a subchannel, this is reflected in the structures under devices/:}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK hhhhubh literal_block)}(hdevices/ - system/ - css0/ - 0.0.0000/0.0.0815/ - 0.0.0001/0.0.4711/ - 0.0.0002/ - 0.1.0000/0.1.1234/ ... - defunct/h]hdevices/ - system/ - css0/ - 0.0.0000/0.0.0815/ - 0.0.0001/0.0.4711/ - 0.0.0002/ - 0.1.0000/0.1.1234/ ... - defunct/}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhKhhhhubh)}(hIn this example, device 0815 is accessed via subchannel 0 in subchannel set 0, device 4711 via subchannel 1 in subchannel set 0, and subchannel 2 is a non-I/O subchannel. Device 1234 is accessed via subchannel 0 in subchannel set 1.h]hIn this example, device 0815 is accessed via subchannel 0 in subchannel set 0, device 4711 via subchannel 1 in subchannel set 0, and subchannel 2 is a non-I/O subchannel. Device 1234 is accessed via subchannel 0 in subchannel set 1.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXgThe subchannel named 'defunct' does not represent any real subchannel on the system; it is a pseudo subchannel where disconnected ccw devices are moved to if they are displaced by another ccw device becoming operational on their former subchannel. The ccw devices will be moved again to a proper subchannel if they become operational again on that subchannel.h]hXkThe subchannel named ‘defunct’ does not represent any real subchannel on the system; it is a pseudo subchannel where disconnected ccw devices are moved to if they are displaced by another ccw device becoming operational on their former subchannel. The ccw devices will be moved again to a proper subchannel if they become operational again on that subchannel.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hoYou should address a ccw device via its bus id (e.g. 0.0.4711); the device can be found under bus/ccw/devices/.h]hoYou should address a ccw device via its bus id (e.g. 0.0.4711); the device can be found under bus/ccw/devices/.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK"hhhhubh)}(h+All ccw devices export some data via sysfs.h]h+All ccw devices export some data via sysfs.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK%hhhhubhdefinition_list)}(hhh](hdefinition_list_item)}(h'cutype: The control unit type / model. h](hterm)}(hcutype:h]hcutype:}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhK(hjKubh definition)}(hhh]h)}(hThe control unit type / model.h]hThe control unit type / model.}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK(hjaubah}(h]h ]h"]h$]h&]uh1j_hjKubeh}(h]h ]h"]h$]h&]uh1jIhhhK(hjFubjJ)}(h1devtype: The device type / model, if applicable. h](jP)}(hdevtype:h]hdevtype:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhK+hj~ubj`)}(hhh]h)}(h'The device type / model, if applicable.h]h'The device type / model, if applicable.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK+hjubah}(h]h ]h"]h$]h&]uh1j_hj~ubeh}(h]h ]h"]h$]h&]uh1jIhhhK+hjFhhubjJ)}(h[availability: Can be 'good' or 'boxed'; 'no path' or 'no device' for disconnected devices. h](jP)}(h availability:h]h availability:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhK/hjubj`)}(hhh]h)}(hLCan be 'good' or 'boxed'; 'no path' or 'no device' for disconnected devices.h]h\Can be ‘good’ or ‘boxed’; ‘no path’ or ‘no device’ for disconnected devices.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK.hjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhK/hjFhhubjJ)}(honline: An interface to set the device online and offline. In the special case of the device being disconnected (see the notify function under 1.2), piping 0 to online will forcibly delete the device. h](jP)}(honline:h]honline:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhK5hjubj`)}(hhh]h)}(hAn interface to set the device online and offline. In the special case of the device being disconnected (see the notify function under 1.2), piping 0 to online will forcibly delete the device.h]hAn interface to set the device online and offline. In the special case of the device being disconnected (see the notify function under 1.2), piping 0 to online will forcibly delete the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK2hjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhK5hjFhhubeh}(h]h ]h"]h$]h&]uh1jDhhhhhhhNubh)}(hLThe device drivers can add entries to export per-device data and interfaces.h]hLThe device drivers can add entries to export per-device data and interfaces.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK7hhhhubh)}(hXThere is also some data exported on a per-subchannel basis (see under bus/css/devices/):h]hXThere is also some data exported on a per-subchannel basis (see under bus/css/devices/):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK9hhhhubjE)}(hhh](jJ)}(h2chpids: Via which chpids the device is connected. h](jP)}(hchpids:h]hchpids:}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhK=hj0ubj`)}(hhh]h)}(h)Via which chpids the device is connected.h]h)Via which chpids the device is connected.}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK=hjBubah}(h]h ]h"]h$]h&]uh1j_hj0ubeh}(h]h ]h"]h$]h&]uh1jIhhhK=hj-ubjJ)}(hJpimpampom: The path installed, path available and path operational masks. h](jP)}(h pimpampom:h]h pimpampom:}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhK@hj_ubj`)}(hhh]h)}(h>The path installed, path available and path operational masks.h]h>The path installed, path available and path operational masks.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK@hjqubah}(h]h ]h"]h$]h&]uh1j_hj_ubeh}(h]h ]h"]h$]h&]uh1jIhhhK@hj-hhubeh}(h]h ]h"]h$]h&]uh1jDhhhhhhhNubh)}(hCThere also might be additional data, for example for block devices.h]hCThere also might be additional data, for example for block devices.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKBhhhhubeh}(h] ccw-devicesah ]h"]1. ccw devicesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h1.1 Bringing up a ccw deviceh]h1.1 Bringing up a ccw device}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKFubh)}(hThis is done in several steps.h]hThis is done in several steps.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKHhjhhubhenumerated_list)}(hhh](h list_item)}(hEach driver can provide one or more parameter interfaces where parameters can be specified. These interfaces are also in the driver's responsibility.h]h)}(hEach driver can provide one or more parameter interfaces where parameters can be specified. These interfaces are also in the driver's responsibility.h]hEach driver can provide one or more parameter interfaces where parameters can be specified. These interfaces are also in the driver’s responsibility.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKJhjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hiAfter a. has been performed, if necessary, the device is finally brought up via the 'online' interface. h]h)}(hgAfter a. has been performed, if necessary, the device is finally brought up via the 'online' interface.h]hkAfter a. has been performed, if necessary, the device is finally brought up via the ‘online’ interface.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h]h ]h"]h$]h&]enumtype loweralphaprefixhsuffix.uh1jhjhhhhhKJubeh}(h]bringing-up-a-ccw-deviceah ]h"]1.1 bringing up a ccw deviceah$]h&]uh1hhhhhhhhKFubh)}(hhh](h)}(h$1.2 Writing a driver for ccw devicesh]h$1.2 Writing a driver for ccw devices}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKQubh)}(hkThe basic struct ccw_device and struct ccw_driver data structures can be found under include/asm/ccwdev.h::h]hjThe basic struct ccw_device and struct ccw_driver data structures can be found under include/asm/ccwdev.h:}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKShjhhubh)}(hXstruct ccw_device { spinlock_t *ccwlock; struct ccw_device_private *private; struct ccw_device_id id; struct ccw_driver *drv; struct device dev; int online; void (*handler) (struct ccw_device *dev, unsigned long intparm, struct irb *irb); }; struct ccw_driver { struct module *owner; struct ccw_device_id *ids; int (*probe) (struct ccw_device *); int (*remove) (struct ccw_device *); int (*set_online) (struct ccw_device *); int (*set_offline) (struct ccw_device *); int (*notify) (struct ccw_device *, int); struct device_driver driver; char *name; };h]hXstruct ccw_device { spinlock_t *ccwlock; struct ccw_device_private *private; struct ccw_device_id id; struct ccw_driver *drv; struct device dev; int online; void (*handler) (struct ccw_device *dev, unsigned long intparm, struct irb *irb); }; struct ccw_driver { struct module *owner; struct ccw_device_id *ids; int (*probe) (struct ccw_device *); int (*remove) (struct ccw_device *); int (*set_online) (struct ccw_device *); int (*set_offline) (struct ccw_device *); int (*notify) (struct ccw_device *, int); struct device_driver driver; char *name; };}hj2sbah}(h]h ]h"]h$]h&]j j uh1hhhhKVhjhhubh)}(htThe 'private' field contains data needed for internal i/o operation only, and is not available to the device driver.h]hxThe ‘private’ field contains data needed for internal i/o operation only, and is not available to the device driver.}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKohjhhubh)}(hEach driver should declare in a MODULE_DEVICE_TABLE into which CU types/models and/or device types/models it is interested. This information can later be found in the struct ccw_device_id fields::h]hEach driver should declare in a MODULE_DEVICE_TABLE into which CU types/models and/or device types/models it is interested. This information can later be found in the struct ccw_device_id fields:}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKrhjhhubh)}(hstruct ccw_device_id { __u16 match_flags; __u16 cu_type; __u16 dev_type; __u8 cu_model; __u8 dev_model; unsigned long driver_info; };h]hstruct ccw_device_id { __u16 match_flags; __u16 cu_type; __u16 dev_type; __u8 cu_model; __u8 dev_model; unsigned long driver_info; };}hj\sbah}(h]h ]h"]h$]h&]j j uh1hhhhKvhjhhubh)}(h@The functions in ccw_driver should be used in the following way:h]h@The functions in ccw_driver should be used in the following way:}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjE)}(hhh]jJ)}(hX probe: This function is called by the device layer for each device the driver is interested in. The driver should only allocate private structures to put in dev->driver_data and create attributes (if needed). Also, the interrupt handler (see below) should be set here. h](jP)}(hprobe:h]hprobe:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhj{ubj`)}(hhh]h)}(hXThis function is called by the device layer for each device the driver is interested in. The driver should only allocate private structures to put in dev->driver_data and create attributes (if needed). Also, the interrupt handler (see below) should be set here.h]hXThis function is called by the device layer for each device the driver is interested in. The driver should only allocate private structures to put in dev->driver_data and create attributes (if needed). Also, the interrupt handler (see below) should be set here.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hj{ubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjxubah}(h]h ]h"]h$]h&]uh1jDhjhhhhhNubh)}(h'int (*probe) (struct ccw_device *cdev);h]h'int (*probe) (struct ccw_device *cdev);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubjE)}(hhh](jJ)}(h5Parameters: cdev - the device to be probed. h](jP)}(h Parameters:h]h Parameters:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]jE)}(hhh]jJ)}(h!cdev - the device to be probed. h](jP)}(hcdevh]hcdev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]h bullet_list)}(hhh]j)}(hthe device to be probed. h]h)}(hthe device to be probed.h]hthe device to be probed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]bullet-uh1jhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubjJ)}(hremove: This function is called by the device layer upon removal of the driver, the device or the module. The driver should perform cleanups here. h](jP)}(hremove:h]hremove:}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhj1ubj`)}(hhh]h)}(hThis function is called by the device layer upon removal of the driver, the device or the module. The driver should perform cleanups here.h]hThis function is called by the device layer upon removal of the driver, the device or the module. The driver should perform cleanups here.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjCubah}(h]h ]h"]h$]h&]uh1j_hj1ubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubh)}(h(int (*remove) (struct ccw_device *cdev);h]h(int (*remove) (struct ccw_device *cdev);}hjfsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubjE)}(hhh](jJ)}(h6Parameters: cdev - the device to be removed. h](jP)}(h Parameters:h]h Parameters:}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjwubj`)}(hhh]jE)}(hhh]jJ)}(h"cdev - the device to be removed. h](jP)}(hcdevh]hcdev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]j)}(hhh]j)}(hthe device to be removed. h]h)}(hthe device to be removed.h]hthe device to be removed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1j_hjwubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjtubjJ)}(hset_online: This function is called by the common I/O layer when the device is activated via the 'online' attribute. The driver should finally setup and activate the device here. h](jP)}(h set_online:h]h set_online:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]h)}(hThis function is called by the common I/O layer when the device is activated via the 'online' attribute. The driver should finally setup and activate the device here.h]hThis function is called by the common I/O layer when the device is activated via the ‘online’ attribute. The driver should finally setup and activate the device here.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjthhubeh}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubh)}(h(int (*set_online) (struct ccw_device *);h]h(int (*set_online) (struct ccw_device *);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubjE)}(hhh](jJ)}(hParameters: cdev - the device to be activated. The common layer has verified that the device is not already online. h](jP)}(h Parameters:h]h Parameters:}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhj)ubj`)}(hhh]jE)}(hhh]jJ)}(hkcdev - the device to be activated. The common layer has verified that the device is not already online. h](jP)}(hcdevh]hcdev}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjAubj`)}(hhh]j)}(hhh]j)}(hbthe device to be activated. The common layer has verified that the device is not already online. h]h)}(h`the device to be activated. The common layer has verified that the device is not already online.h]h`the device to be activated. The common layer has verified that the device is not already online.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjYubah}(h]h ]h"]h$]h&]uh1jhjVubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjSubah}(h]h ]h"]h$]h&]uh1j_hjAubeh}(h]h ]h"]h$]h&]uh1jIhhhKhj>ubah}(h]h ]h"]h$]h&]uh1jDhj;ubah}(h]h ]h"]h$]h&]uh1j_hj)ubeh}(h]h ]h"]h$]h&]uh1jIhhhKhj&ubjJ)}(hset_offline: This function is called by the common I/O layer when the device is de-activated via the 'online' attribute. The driver should shut down the device, but not de-allocate its private data. h](jP)}(hOset_offline: This function is called by the common I/O layer when the device ish]hOset_offline: This function is called by the common I/O layer when the device is}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]h)}(hvde-activated via the 'online' attribute. The driver should shut down the device, but not de-allocate its private data.h]hzde-activated via the ‘online’ attribute. The driver should shut down the device, but not de-allocate its private data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhj&hhubeh}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubh)}(h)int (*set_offline) (struct ccw_device *);h]h)int (*set_offline) (struct ccw_device *);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubjE)}(hhh](jJ)}(h~Parameters: cdev - the device to be deactivated. The common layer has verified that the device is online. h](jP)}(h Parameters:h]h Parameters:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]jE)}(hhh]jJ)}(hbcdev - the device to be deactivated. The common layer has verified that the device is online. h](jP)}(hcdevh]hcdev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]j)}(hhh]j)}(hYthe device to be deactivated. The common layer has verified that the device is online. h]jE)}(hhh]jJ)}(hXthe device to be deactivated. The common layer has verified that the device is online. h](jP)}(h2the device to be deactivated. The common layer hash]h2the device to be deactivated. The common layer has}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]h)}(h#verified that the device is online.h]h#verified that the device is online.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj$ubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubah}(h]h ]h"]h$]h&]uh1jDhj ubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubah}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubjJ)}(hXinotify: This function is called by the common I/O layer for some state changes of the device. Signalled to the driver are: * In online state, device detached (CIO_GONE) or last path gone (CIO_NO_PATH). The driver must return !0 to keep the device; for return code 0, the device will be deleted as usual (also when no notify function is registered). If the driver wants to keep the device, it is moved into disconnected state. * In disconnected state, device operational again (CIO_OPER). The common I/O layer performs some sanity checks on device number and Device / CU to be reasonably sure if it is still the same device. If not, the old device is removed and a new one registered. By the return code of the notify function the device driver signals if it wants the device back: !0 for keeping, 0 to make the device being removed and re-registered. h](jP)}(hnotify:h]hnotify:}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjqubj`)}(hhh](h)}(hUThis function is called by the common I/O layer for some state changes of the device.h]hUThis function is called by the common I/O layer for some state changes of the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubh)}(hSignalled to the driver are:h]hSignalled to the driver are:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hhh](j)}(hX,In online state, device detached (CIO_GONE) or last path gone (CIO_NO_PATH). The driver must return !0 to keep the device; for return code 0, the device will be deleted as usual (also when no notify function is registered). If the driver wants to keep the device, it is moved into disconnected state.h]h)}(hX,In online state, device detached (CIO_GONE) or last path gone (CIO_NO_PATH). The driver must return !0 to keep the device; for return code 0, the device will be deleted as usual (also when no notify function is registered). If the driver wants to keep the device, it is moved into disconnected state.h]hX,In online state, device detached (CIO_GONE) or last path gone (CIO_NO_PATH). The driver must return !0 to keep the device; for return code 0, the device will be deleted as usual (also when no notify function is registered). If the driver wants to keep the device, it is moved into disconnected state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hXIn disconnected state, device operational again (CIO_OPER). The common I/O layer performs some sanity checks on device number and Device / CU to be reasonably sure if it is still the same device. If not, the old device is removed and a new one registered. By the return code of the notify function the device driver signals if it wants the device back: !0 for keeping, 0 to make the device being removed and re-registered. h]h)}(hXIn disconnected state, device operational again (CIO_OPER). The common I/O layer performs some sanity checks on device number and Device / CU to be reasonably sure if it is still the same device. If not, the old device is removed and a new one registered. By the return code of the notify function the device driver signals if it wants the device back: !0 for keeping, 0 to make the device being removed and re-registered.h]hXIn disconnected state, device operational again (CIO_OPER). The common I/O layer performs some sanity checks on device number and Device / CU to be reasonably sure if it is still the same device. If not, the old device is removed and a new one registered. By the return code of the notify function the device driver signals if it wants the device back: !0 for keeping, 0 to make the device being removed and re-registered.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j*uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1j_hjqubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjhhubeh}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubh)}(h)int (*notify) (struct ccw_device *, int);h]h)int (*notify) (struct ccw_device *, int);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubjE)}(hhh]jJ)}(hParameters: cdev - the device whose state changed. event - the event that happened. This can be one of CIO_GONE, CIO_NO_PATH or CIO_OPER. h](jP)}(h Parameters:h]h Parameters:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]jE)}(hhh](jJ)}(h'cdev - the device whose state changed. h](jP)}(hcdevh]hcdev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]j)}(hhh]j)}(h the device whose state changed. h]h)}(hthe device whose state changed.h]hthe device whose state changed.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj/ubah}(h]h ]h"]h$]h&]uh1jhj,ubah}(h]h ]h"]h$]h&]jjuh1jhhhKhj)ubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubjJ)}(hYevent - the event that happened. This can be one of CIO_GONE, CIO_NO_PATH or CIO_OPER. h](jP)}(heventh]hevent}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjYubj`)}(hhh]j)}(hhh]j)}(hOthe event that happened. This can be one of CIO_GONE, CIO_NO_PATH or CIO_OPER. h]h)}(hNthe event that happened. This can be one of CIO_GONE, CIO_NO_PATH or CIO_OPER.h]hNthe event that happened. This can be one of CIO_GONE, CIO_NO_PATH or CIO_OPER.}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjqubah}(h]h ]h"]h$]h&]uh1jhjnubah}(h]h ]h"]h$]h&]jjuh1jhhhKhjkubah}(h]h ]h"]h$]h&]uh1j_hjYubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubeh}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubah}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubh)}(hX8The handler field of the struct ccw_device is meant to be set to the interrupt handler for the device. In order to accommodate drivers which use several distinct handlers (e.g. multi subchannel devices), this is a member of ccw_device instead of ccw_driver. The handler is registered with the common layer during set_online() processing before the driver is called, and is deregistered during set_offline() after the driver has been called. Also, after registering / before deregistering, path grouping resp. disbanding of the path group (if applicable) are performed.h]hX8The handler field of the struct ccw_device is meant to be set to the interrupt handler for the device. In order to accommodate drivers which use several distinct handlers (e.g. multi subchannel devices), this is a member of ccw_device instead of ccw_driver. The handler is registered with the common layer during set_online() processing before the driver is called, and is deregistered during set_offline() after the driver has been called. Also, after registering / before deregistering, path grouping resp. disbanding of the path group (if applicable) are performed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hQvoid (*handler) (struct ccw_device *dev, unsigned long intparm, struct irb *irb);h]hQvoid (*handler) (struct ccw_device *dev, unsigned long intparm, struct irb *irb);}hjsbah}(h]h ]h"]h$]h&]j j uh1hhhhKhjhhubjE)}(hhh]jJ)}(hXCParameters: dev - the device the handler is called for intparm - the intparm which allows the device driver to identify the i/o the interrupt is associated with, or to recognize the interrupt as unsolicited. irb - interruption response block which contains the accumulated status. h](jP)}(h>Parameters: dev - the device the handler is called forh]h>Parameters: dev - the device the handler is called for}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]jE)}(hhh](jJ)}(hintparm - the intparm which allows the device driver to identify the i/o the interrupt is associated with, or to recognize the interrupt as unsolicited.h](jP)}(h@intparm - the intparm which allows the device driver to identifyh]h@intparm - the intparm which allows the device driver to identify}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]h)}(hWthe i/o the interrupt is associated with, or to recognize the interrupt as unsolicited.h]hWthe i/o the interrupt is associated with, or to recognize the interrupt as unsolicited.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubjJ)}(hMirb - interruption response block which contains the accumulated status. h](jP)}(hDirb - interruption response block which contains the accumulatedh]hDirb - interruption response block which contains the accumulated}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhKhjubj`)}(hhh]h)}(hstatus.h]hstatus.}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj+ubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubeh}(h]h ]h"]h$]h&]uh1jDhjubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhKhjubah}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubh)}(hThe device driver is called from the common ccw_device layer and can retrieve information about the interrupt from the irb parameter.h]hThe device driver is called from the common ccw_device layer and can retrieve information about the interrupt from the irb parameter.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h] writing-a-driver-for-ccw-devicesah ]h"]$1.2 writing a driver for ccw devicesah$]h&]uh1hhhhhhhhKQubh)}(hhh](h)}(h1.3 ccwgroup devicesh]h1.3 ccwgroup devices}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjvhhhhhKubh)}(hjThe ccwgroup mechanism is designed to handle devices consisting of multiple ccw devices, like qeth or ctc.h]hjThe ccwgroup mechanism is designed to handle devices consisting of multiple ccw devices, like qeth or ctc.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjvhhubh)}(hThe ccw driver provides a 'group' attribute. Piping bus ids of ccw devices to this attributes creates a ccwgroup device consisting of these ccw devices (if possible). This ccwgroup device can be set online or offline just like a normal ccw device.h]hThe ccw driver provides a ‘group’ attribute. Piping bus ids of ccw devices to this attributes creates a ccwgroup device consisting of these ccw devices (if possible). This ccwgroup device can be set online or offline just like a normal ccw device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjvhhubh)}(hEach ccwgroup device also provides an 'ungroup' attribute to destroy the device again (only when offline). This is a generic ccwgroup mechanism (the driver does not need to implement anything beyond normal removal routines).h]hEach ccwgroup device also provides an ‘ungroup’ attribute to destroy the device again (only when offline). This is a generic ccwgroup mechanism (the driver does not need to implement anything beyond normal removal routines).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjvhhubh)}(hA ccw device which is a member of a ccwgroup device carries a pointer to the ccwgroup device in the driver_data of its device struct. This field must not be touched by the driver - it should use the ccwgroup device's driver_data for its private data.h]hA ccw device which is a member of a ccwgroup device carries a pointer to the ccwgroup device in the driver_data of its device struct. This field must not be touched by the driver - it should use the ccwgroup device’s driver_data for its private data.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjvhhubh)}(hTo implement a ccwgroup driver, please refer to include/asm/ccwgroup.h. Keep in mind that most drivers will need to implement both a ccwgroup and a ccw driver.h]hTo implement a ccwgroup driver, please refer to include/asm/ccwgroup.h. Keep in mind that most drivers will need to implement both a ccwgroup and a ccw driver.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjvhhubeh}(h]ccwgroup-devicesah ]h"]1.3 ccwgroup devicesah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h2. Channel pathsh]h2. Channel paths}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM ubh)}(hXChannel paths show up, like subchannels, under the channel subsystem root (css0) and are called 'chp0.'. They have no driver and do not belong to any bus. Please note, that unlike /proc/chpids in 2.4, the channel path objects reflect only the logical state and not the physical state, since we cannot track the latter consistently due to lacking machine support (we don't need to be aware of it anyway).h]hXChannel paths show up, like subchannels, under the channel subsystem root (css0) and are called ‘chp0.’. They have no driver and do not belong to any bus. Please note, that unlike /proc/chpids in 2.4, the channel path objects reflect only the logical state and not the physical state, since we cannot track the latter consistently due to lacking machine support (we don’t need to be aware of it anyway).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjE)}(hhh](jJ)}(hX[status - Can be 'online' or 'offline'. Piping 'on' or 'off' sets the chpid logically online/offline. Piping 'on' to an online chpid triggers path reprobing for all devices the chpid connects to. This can be used to force the kernel to reuse a channel path the user knows to be online, but the machine hasn't created a machine check for. h](jP)}(hstatush]hstatus}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhMhjubj`)}(hhh]j)}(hhh]j)}(hXHCan be 'online' or 'offline'. Piping 'on' or 'off' sets the chpid logically online/offline. Piping 'on' to an online chpid triggers path reprobing for all devices the chpid connects to. This can be used to force the kernel to reuse a channel path the user knows to be online, but the machine hasn't created a machine check for. h]h)}(hXGCan be 'online' or 'offline'. Piping 'on' or 'off' sets the chpid logically online/offline. Piping 'on' to an online chpid triggers path reprobing for all devices the chpid connects to. This can be used to force the kernel to reuse a channel path the user knows to be online, but the machine hasn't created a machine check for.h]hX]Can be ‘online’ or ‘offline’. Piping ‘on’ or ‘off’ sets the chpid logically online/offline. Piping ‘on’ to an online chpid triggers path reprobing for all devices the chpid connects to. This can be used to force the kernel to reuse a channel path the user knows to be online, but the machine hasn’t created a machine check for.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhhhMhj ubah}(h]h ]h"]h$]h&]uh1j_hjubeh}(h]h ]h"]h$]h&]uh1jIhhhMhjubjJ)}(h.type - The physical type of the channel path. h](jP)}(htypeh]htype}(hj= hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhMhj9 ubj`)}(hhh]j)}(hhh]j)}(h'The physical type of the channel path. h]h)}(h&The physical type of the channel path.h]h&The physical type of the channel path.}(hjU hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjQ ubah}(h]h ]h"]h$]h&]uh1jhjN ubah}(h]h ]h"]h$]h&]jjuh1jhhhMhjK ubah}(h]h ]h"]h$]h&]uh1j_hj9 ubeh}(h]h ]h"]h$]h&]uh1jIhhhMhjhhubjJ)}(h-shared - Whether the channel path is shared. h](jP)}(hsharedh]hshared}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhM"hj{ ubj`)}(hhh]j)}(hhh]j)}(h$Whether the channel path is shared. h]h)}(h#Whether the channel path is shared.h]h#Whether the channel path is shared.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM"hj ubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhhhM"hj ubah}(h]h ]h"]h$]h&]uh1j_hj{ ubeh}(h]h ]h"]h$]h&]uh1jIhhhM"hjhhubjJ)}(h%cmg - The channel measurement group. h](jP)}(hcmgh]hcmg}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jOhhhM%hj ubj`)}(hhh]j)}(hhh]j)}(hThe channel measurement group. h]h)}(hThe channel measurement group.h]hThe channel measurement group.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM%hj ubah}(h]h ]h"]h$]h&]uh1jhj ubah}(h]h ]h"]h$]h&]jjuh1jhhhM%hj ubah}(h]h ]h"]h$]h&]uh1j_hj ubeh}(h]h ]h"]h$]h&]uh1jIhhhM%hjhhubeh}(h]h ]h"]h$]h&]uh1jDhjhhhNhNubeh}(h] channel-pathsah ]h"]2. channel pathsah$]h&]uh1hhhhhhhhM ubh)}(hhh]h)}(h3. System devicesh]h3. System devices}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhM(ubah}(h]system-devicesah ]h"]3. system devicesah$]h&]uh1hhhhhhhhM(ubh)}(hhh](h)}(h 3.1 xpramh]h 3.1 xpram}(hj) hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj& hhhhhM+ubh)}(h0xpram shows up under devices/system/ as 'xpram'.h]h4xpram shows up under devices/system/ as ‘xpram’.}(hj7 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM-hj& hhubeh}(h]xpramah ]h"] 3.1 xpramah$]h&]uh1hhhhhhhhM+ubh)}(hhh](h)}(h3.2 cpush]h3.2 cpus}(hjP hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjM hhhhhM0ubh)}(hwFor each cpu, a directory is created under devices/system/cpu/. Each cpu has an attribute 'online' which can be 0 or 1.h]h{For each cpu, a directory is created under devices/system/cpu/. Each cpu has an attribute ‘online’ which can be 0 or 1.}(hj^ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM2hjM hhubeh}(h]cpusah ]h"]3.2 cpusah$]h&]uh1hhhhhhhhM0ubeh}(h]s-390-driver-model-interfacesah ]h"]s/390 driver model interfacesah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehʌ _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}refids}nameids}(jy jv jjjj jsjpjjj j j# j jJ jG jq jn u nametypes}(jy jjjsjj j# jJ jq uh}(jv hjhj jjpjjjvj jj j jG j& jn jM u footnote_refs} citation_refs} autofootnotes]autofootnote_refs]symbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}Rparse_messages]transform_messages] transformerN include_log] decorationNhhub.