Isphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget"/translations/zh_CN/driver-api/spimodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/zh_TW/driver-api/spimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/it_IT/driver-api/spimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/ja_JP/driver-api/spimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/ko_KR/driver-api/spimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/pt_BR/driver-api/spimodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget"/translations/sp_SP/driver-api/spimodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhsection)}(hhh](htitle)}(h!Serial Peripheral Interface (SPI)h]h!Serial Peripheral Interface (SPI)}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhh`. SPI devices are children of that master, represented as a :c:type:`struct spi_device ` and manufactured from :c:type:`struct spi_board_info ` descriptors which are usually provided by board-specific initialization code. A :c:type:`struct spi_driver ` is called a "Protocol Driver", and is bound to a spi_device using normal driver model calls.h](hXThe programming interface is structured around two kinds of driver, and two kinds of device. A “Controller Driver” abstracts the controller hardware, which may be as simple as a set of GPIO pins or as complex as a pair of FIFOs connected to dual DMA engines on the other side of the SPI shift register (maximizing throughput). Such drivers bridge between whatever bus they sit on (often the platform bus) and SPI, and expose the SPI side of their device as a }(hhhhhNhNubh)}(h0:c:type:`struct spi_controller `h]hliteral)}(hhh]hstruct spi_controller}(hhhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdocdriver-api/spi refdomainjreftypetype refexplicitrefwarn reftargetspi_controlleruh1hhhhKhhubh<. SPI devices are children of that master, represented as a }(hhhhhNhNubh)}(h(:c:type:`struct spi_device `h]h)}(hjh]hstruct spi_device}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj spi_deviceuh1hhhhKhhubh and manufactured from }(hhhhhNhNubh)}(h0:c:type:`struct spi_board_info `h]h)}(hj?h]hstruct spi_board_info}(hjAhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhj=ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjspi_board_infouh1hhhhKhhubhQ descriptors which are usually provided by board-specific initialization code. A }(hhhhhNhNubh)}(h(:c:type:`struct spi_driver `h]h)}(hjbh]hstruct spi_driver}(hjdhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhj`ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj spi_driveruh1hhhhKhhubha is called a “Protocol Driver”, and is bound to a spi_device using normal driver model calls.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hXThe I/O model is a set of queued messages. Protocol drivers submit one or more :c:type:`struct spi_message ` objects, which are processed and completed asynchronously. (There are synchronous wrappers, however.) Messages are built from one or more :c:type:`struct spi_transfer ` objects, each of which wraps a full duplex SPI transfer. A variety of protocol tweaking options are needed, because different chips adopt very different policies for how they use the bits transferred with SPI.h](hOThe I/O model is a set of queued messages. Protocol drivers submit one or more }(hjhhhNhNubh)}(h*:c:type:`struct spi_message `h]h)}(hjh]hstruct spi_message}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj spi_messageuh1hhhhK%hjubh objects, which are processed and completed asynchronously. (There are synchronous wrappers, however.) Messages are built from one or more }(hjhhhNhNubh)}(h,:c:type:`struct spi_transfer `h]h)}(hjh]hstruct spi_transfer}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj spi_transferuh1hhhhK%hjubh objects, each of which wraps a full duplex SPI transfer. A variety of protocol tweaking options are needed, because different chips adopt very different policies for how they use the bits transferred with SPI.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK%hhhhubhindex)}(hhh]h}(h]h ]h"]h$]h&]entries](singlespi_statistics (C struct)c.spi_statisticshNtauh1jhhhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhNubhdesc)}(hhh](hdesc_signature)}(hspi_statisticsh]hdesc_signature_line)}(hstruct spi_statisticsh](hdesc_sig_keyword)}(hstructh]hstruct}(hjhhhNhNubah}(h]h ]kah"]h$]h&]uh1jhjhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKubhdesc_sig_space)}(h h]h }(hjhhhNhNubah}(h]h ]wah"]h$]h&]uh1jhjhhhjhKubh desc_name)}(hspi_statisticsh]h desc_sig_name)}(hjh]hspi_statistics}(hj+hhhNhNubah}(h]h ]nah"]h$]h&]uh1j)hj%ubah}(h]h ](sig-namedescnameeh"]h$]h&] xml:spacepreserveuh1j#hjhhhjhKubeh}(h]h ]h"]h$]h&]jAjB add_permalinkuh1jsphinx_line_type declaratorhjhhhjhKubah}(h]jah ](sig sig-objecteh"]h$]h&] is_multiline _toc_parts) _toc_namehuh1jhjhKhjhhubh desc_content)}(hhh]h)}(hstatistics for spi transfersh]hstatistics for spi transfers}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK1hjYhhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjhKubeh}(h]h ](jstructeh"]h$]h&]domainjobjtypejtdesctypejtnoindex noindexentrynocontentsentryuh1jhhhhhjhNubh container)}(hXW**Definition**:: struct spi_statistics { struct u64_stats_sync syncp; u64_stats_t messages; u64_stats_t transfers; u64_stats_t errors; u64_stats_t timedout; u64_stats_t spi_sync; u64_stats_t spi_sync_immediate; u64_stats_t spi_async; u64_stats_t bytes; u64_stats_t bytes_rx; u64_stats_t bytes_tx; #define SPI_STATISTICS_HISTO_SIZE 17; u64_stats_t transfer_bytes_histo[SPI_STATISTICS_HISTO_SIZE]; u64_stats_t transfers_split_maxsize; }; **Members** ``syncp`` seqcount to protect members in this struct for per-cpu update on 32-bit systems ``messages`` number of spi-messages handled ``transfers`` number of spi_transfers handled ``errors`` number of errors during spi_transfer ``timedout`` number of timeouts during spi_transfer ``spi_sync`` number of times spi_sync is used ``spi_sync_immediate`` number of times spi_sync is executed immediately in calling context without queuing and scheduling ``spi_async`` number of times spi_async is used ``bytes`` number of bytes transferred to/from device ``bytes_rx`` number of bytes received from device ``bytes_tx`` number of bytes sent to device ``transfer_bytes_histo`` transfer bytes histogram ``transfers_split_maxsize`` number of transfers that have been split because of maxsize limith](h)}(h**Definition**::h](hstrong)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK5hjubh literal_block)}(hXstruct spi_statistics { struct u64_stats_sync syncp; u64_stats_t messages; u64_stats_t transfers; u64_stats_t errors; u64_stats_t timedout; u64_stats_t spi_sync; u64_stats_t spi_sync_immediate; u64_stats_t spi_async; u64_stats_t bytes; u64_stats_t bytes_rx; u64_stats_t bytes_tx; #define SPI_STATISTICS_HISTO_SIZE 17; u64_stats_t transfer_bytes_histo[SPI_STATISTICS_HISTO_SIZE]; u64_stats_t transfers_split_maxsize; };h]hXstruct spi_statistics { struct u64_stats_sync syncp; u64_stats_t messages; u64_stats_t transfers; u64_stats_t errors; u64_stats_t timedout; u64_stats_t spi_sync; u64_stats_t spi_sync_immediate; u64_stats_t spi_async; u64_stats_t bytes; u64_stats_t bytes_rx; u64_stats_t bytes_tx; #define SPI_STATISTICS_HISTO_SIZE 17; u64_stats_t transfer_bytes_histo[SPI_STATISTICS_HISTO_SIZE]; u64_stats_t transfers_split_maxsize; };}hjsbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK7hjubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKHhjubhdefinition_list)}(hhh](hdefinition_list_item)}(hZ``syncp`` seqcount to protect members in this struct for per-cpu update on 32-bit systems h](hterm)}(h ``syncp``h]h)}(hjh]hsyncp}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK4hjubh definition)}(hhh]h)}(hOseqcount to protect members in this struct for per-cpu update on 32-bit systemsh]hOseqcount to protect members in this struct for per-cpu update on 32-bit systems}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK3hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK4hjubj)}(h,``messages`` number of spi-messages handled h](j)}(h ``messages``h]h)}(hjh]hmessages}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK6hjubj)}(hhh]h)}(hnumber of spi-messages handledh]hnumber of spi-messages handled}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hK6hj-ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj,hK6hjubj)}(h.``transfers`` number of spi_transfers handled h](j)}(h ``transfers``h]h)}(hjPh]h transfers}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK7hjJubj)}(hhh]h)}(hnumber of spi_transfers handledh]hnumber of spi_transfers handled}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjehK7hjfubah}(h]h ]h"]h$]h&]uh1jhjJubeh}(h]h ]h"]h$]h&]uh1jhjehK7hjubj)}(h0``errors`` number of errors during spi_transfer h](j)}(h ``errors``h]h)}(hjh]herrors}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK8hjubj)}(hhh]h)}(h$number of errors during spi_transferh]h$number of errors during spi_transfer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK8hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK8hjubj)}(h4``timedout`` number of timeouts during spi_transfer h](j)}(h ``timedout``h]h)}(hjh]htimedout}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK9hjubj)}(hhh]h)}(h&number of timeouts during spi_transferh]h&number of timeouts during spi_transfer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK9hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK9hjubj)}(h.``spi_sync`` number of times spi_sync is used h](j)}(h ``spi_sync``h]h)}(hjh]hspi_sync}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK;hjubj)}(hhh]h)}(h number of times spi_sync is usedh]h number of times spi_sync is used}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhK;hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhK;hjubj)}(hz``spi_sync_immediate`` number of times spi_sync is executed immediately in calling context without queuing and scheduling h](j)}(h``spi_sync_immediate``h]h)}(hj4h]hspi_sync_immediate}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK=hj.ubj)}(hhh]h)}(hbnumber of times spi_sync is executed immediately in calling context without queuing and schedulingh]hbnumber of times spi_sync is executed immediately in calling context without queuing and scheduling}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKjzj>j{j|j}uh1jhhhhhjhNubj)}(hX**Definition**:: struct spi_delay { #define SPI_DELAY_UNIT_USECS 0; #define SPI_DELAY_UNIT_NSECS 1; #define SPI_DELAY_UNIT_SCK 2; u16 value; u8 unit; }; **Members** ``value`` Value for the delay ``unit`` Unit for the delayh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubh:}(hjFhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK|hjBubj)}(hstruct spi_delay { #define SPI_DELAY_UNIT_USECS 0; #define SPI_DELAY_UNIT_NSECS 1; #define SPI_DELAY_UNIT_SCK 2; u16 value; u8 unit; };h]hstruct spi_delay { #define SPI_DELAY_UNIT_USECS 0; #define SPI_DELAY_UNIT_NSECS 1; #define SPI_DELAY_UNIT_SCK 2; u16 value; u8 unit; };}hjcsbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK~hjBubh)}(h **Members**h]j)}(hjth]hMembers}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjBubj)}(hhh](j)}(h``value`` Value for the delay h](j)}(h ``value``h]h)}(hjh]hvalue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKzhjubj)}(hhh]h)}(hValue for the delayh]hValue for the delay}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKzhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKzhjubj)}(h``unit`` Unit for the delayh](j)}(h``unit``h]h)}(hjh]hunit}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKzhjubj)}(hhh]h)}(hUnit for the delayh]hUnit for the delay}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhK{hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKzhjubeh}(h]h ]h"]h$]h&]uh1jhjBubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_device (C struct) c.spi_devicehNtauh1jhhhhhjhNubj)}(hhh](j)}(h spi_deviceh]j)}(hstruct spi_deviceh](j)}(hjh]hstruct}(hj&hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj"hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKubj)}(h h]h }(hj4hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj"hhhj3hKubj$)}(h spi_deviceh]j*)}(hj h]h spi_device}(hjFhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjBubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj"hhhj3hKubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhj3hKubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj3hKhjhhubjX)}(hhh]h)}(h.Controller side proxy for an SPI target deviceh]h.Controller side proxy for an SPI target device}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjehhubah}(h]h ]h"]h$]h&]uh1jWhjhhhj3hKubeh}(h]h ](jstructeh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhjhNubj)}(hX0**Definition**:: struct spi_device { struct device dev; struct spi_controller *controller; u32 max_speed_hz; u8 bits_per_word; bool rt; #define SPI_NO_TX BIT(31) ; #define SPI_NO_RX BIT(30) ; #define SPI_TPM_HW_FLOW BIT(29) ; #define SPI_MODE_KERNEL_MASK (~(BIT(29) - 1)); u32 mode; int irq; void *controller_state; void *controller_data; char modalias[SPI_NAME_SIZE]; struct spi_statistics __percpu *pcpu_statistics; struct spi_delay word_delay; struct spi_delay cs_setup; struct spi_delay cs_hold; struct spi_delay cs_inactive; u32 rx_sample_delay_ns; u8 chip_select[SPI_DEVICE_CS_CNT_MAX]; u8 num_chipselect; u32 cs_index_mask : SPI_DEVICE_CS_CNT_MAX; struct gpio_desc *cs_gpiod[SPI_DEVICE_CS_CNT_MAX]; u8 tx_lane_map[SPI_DEVICE_DATA_LANE_CNT_MAX]; u8 num_tx_lanes; u8 rx_lane_map[SPI_DEVICE_DATA_LANE_CNT_MAX]; u8 num_rx_lanes; #if IS_ENABLED(CONFIG_SPI_DYNAMIC); struct list_head userspace_node; #endif; }; **Members** ``dev`` Driver model representation of the device. ``controller`` SPI controller used with the device. ``max_speed_hz`` Maximum clock rate to be used with this chip (on this board); may be changed by the device's driver. The spi_transfer.speed_hz can override this for each transfer. ``bits_per_word`` Data transfers involve one or more words; word sizes like eight or 12 bits are common. In-memory wordsizes are powers of two bytes (e.g. 20 bit samples use 32 bits). This may be changed by the device's driver, or left at the default (0) indicating protocol words are eight bit bytes. The spi_transfer.bits_per_word can override this for each transfer. ``rt`` Make the pump thread real time priority. ``mode`` The spi mode defines how data is clocked out and in. This may be changed by the device's driver. The "active low" default for chipselect mode can be overridden (by specifying SPI_CS_HIGH) as can the "MSB first" default for each word in a transfer (by specifying SPI_LSB_FIRST). ``irq`` Negative, or the number passed to request_irq() to receive interrupts from this device. ``controller_state`` Controller's runtime state ``controller_data`` Board-specific definitions for controller, such as FIFO initialization parameters; from board_info.controller_data ``modalias`` Name of the driver to use with this device, or an alias for that name. This appears in the sysfs "modalias" attribute for driver coldplugging, and in uevents used for hotplugging ``pcpu_statistics`` statistics for the spi_device ``word_delay`` delay to be inserted between consecutive words of a transfer ``cs_setup`` delay to be introduced by the controller after CS is asserted ``cs_hold`` delay to be introduced by the controller before CS is deasserted ``cs_inactive`` delay to be introduced by the controller after CS is deasserted. If **cs_change_delay** is used from **spi_transfer**, then the two delays will be added up. ``rx_sample_delay_ns`` Delay in nanoseconds by which the controller should postpone sampling the incoming data, relative to the sampling point it uses by default. Describes the board rather than the device, namely the flight time of the clock and data signals between controller and device, and comes from the "rx-sample-delay-ns" property. Zero when the property is absent. ``chip_select`` Array of physical chipselect, spi->chipselect[i] gives the corresponding physical CS for logical CS i. ``num_chipselect`` Number of physical chipselects used. ``cs_index_mask`` Bit mask of the active chipselect(s) in the chipselect array ``cs_gpiod`` Array of GPIO descriptors of the corresponding chipselect lines (optional, NULL when not using a GPIO line) ``tx_lane_map`` Map of peripheral lanes (index) to controller lanes (value). ``num_tx_lanes`` Number of transmit lanes wired up. ``rx_lane_map`` Map of peripheral lanes (index) to controller lanes (value). ``num_rx_lanes`` Number of receive lanes wired up. ``userspace_node`` entry on the parent controller's userspace_clients list when this device was instantiated via the sysfs new_device interfaceh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubj)}(hXXstruct spi_device { struct device dev; struct spi_controller *controller; u32 max_speed_hz; u8 bits_per_word; bool rt; #define SPI_NO_TX BIT(31) ; #define SPI_NO_RX BIT(30) ; #define SPI_TPM_HW_FLOW BIT(29) ; #define SPI_MODE_KERNEL_MASK (~(BIT(29) - 1)); u32 mode; int irq; void *controller_state; void *controller_data; char modalias[SPI_NAME_SIZE]; struct spi_statistics __percpu *pcpu_statistics; struct spi_delay word_delay; struct spi_delay cs_setup; struct spi_delay cs_hold; struct spi_delay cs_inactive; u32 rx_sample_delay_ns; u8 chip_select[SPI_DEVICE_CS_CNT_MAX]; u8 num_chipselect; u32 cs_index_mask : SPI_DEVICE_CS_CNT_MAX; struct gpio_desc *cs_gpiod[SPI_DEVICE_CS_CNT_MAX]; u8 tx_lane_map[SPI_DEVICE_DATA_LANE_CNT_MAX]; u8 num_tx_lanes; u8 rx_lane_map[SPI_DEVICE_DATA_LANE_CNT_MAX]; u8 num_rx_lanes; #if IS_ENABLED(CONFIG_SPI_DYNAMIC); struct list_head userspace_node; #endif; };h]hXXstruct spi_device { struct device dev; struct spi_controller *controller; u32 max_speed_hz; u8 bits_per_word; bool rt; #define SPI_NO_TX BIT(31) ; #define SPI_NO_RX BIT(30) ; #define SPI_TPM_HW_FLOW BIT(29) ; #define SPI_MODE_KERNEL_MASK (~(BIT(29) - 1)); u32 mode; int irq; void *controller_state; void *controller_data; char modalias[SPI_NAME_SIZE]; struct spi_statistics __percpu *pcpu_statistics; struct spi_delay word_delay; struct spi_delay cs_setup; struct spi_delay cs_hold; struct spi_delay cs_inactive; u32 rx_sample_delay_ns; u8 chip_select[SPI_DEVICE_CS_CNT_MAX]; u8 num_chipselect; u32 cs_index_mask : SPI_DEVICE_CS_CNT_MAX; struct gpio_desc *cs_gpiod[SPI_DEVICE_CS_CNT_MAX]; u8 tx_lane_map[SPI_DEVICE_DATA_LANE_CNT_MAX]; u8 num_tx_lanes; u8 rx_lane_map[SPI_DEVICE_DATA_LANE_CNT_MAX]; u8 num_rx_lanes; #if IS_ENABLED(CONFIG_SPI_DYNAMIC); struct list_head userspace_node; #endif; };}hjsbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubh)}(h **Members**h]j)}(hjh]hMembers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubj)}(hhh](j)}(h3``dev`` Driver model representation of the device. h](j)}(h``dev``h]h)}(hjh]hdev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubj)}(hhh]h)}(h*Driver model representation of the device.h]h*Driver model representation of the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h4``controller`` SPI controller used with the device. h](j)}(h``controller``h]h)}(hjh]h controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubj)}(hhh]h)}(h$SPI controller used with the device.h]h$SPI controller used with the device.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hKhj$ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj#hKhjubj)}(h``max_speed_hz`` Maximum clock rate to be used with this chip (on this board); may be changed by the device's driver. The spi_transfer.speed_hz can override this for each transfer. h](j)}(h``max_speed_hz``h]h)}(hjGh]h max_speed_hz}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjAubj)}(hhh]h)}(hMaximum clock rate to be used with this chip (on this board); may be changed by the device's driver. The spi_transfer.speed_hz can override this for each transfer.h]hMaximum clock rate to be used with this chip (on this board); may be changed by the device’s driver. The spi_transfer.speed_hz can override this for each transfer.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj]ubah}(h]h ]h"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]uh1jhj\hKhjubj)}(hXs``bits_per_word`` Data transfers involve one or more words; word sizes like eight or 12 bits are common. In-memory wordsizes are powers of two bytes (e.g. 20 bit samples use 32 bits). This may be changed by the device's driver, or left at the default (0) indicating protocol words are eight bit bytes. The spi_transfer.bits_per_word can override this for each transfer. h](j)}(h``bits_per_word``h]h)}(hjh]h bits_per_word}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj{ubj)}(hhh]h)}(hX`Data transfers involve one or more words; word sizes like eight or 12 bits are common. In-memory wordsizes are powers of two bytes (e.g. 20 bit samples use 32 bits). This may be changed by the device's driver, or left at the default (0) indicating protocol words are eight bit bytes. The spi_transfer.bits_per_word can override this for each transfer.h]hXbData transfers involve one or more words; word sizes like eight or 12 bits are common. In-memory wordsizes are powers of two bytes (e.g. 20 bit samples use 32 bits). This may be changed by the device’s driver, or left at the default (0) indicating protocol words are eight bit bytes. The spi_transfer.bits_per_word can override this for each transfer.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubah}(h]h ]h"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(h0``rt`` Make the pump thread real time priority. h](j)}(h``rt``h]h)}(hjh]hrt}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubj)}(hhh]h)}(h(Make the pump thread real time priority.h]h(Make the pump thread real time priority.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhKhjubj)}(hX``mode`` The spi mode defines how data is clocked out and in. This may be changed by the device's driver. The "active low" default for chipselect mode can be overridden (by specifying SPI_CS_HIGH) as can the "MSB first" default for each word in a transfer (by specifying SPI_LSB_FIRST). h](j)}(h``mode``h]h)}(hjh]hmode}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjubj)}(hhh]h)}(hXThe spi mode defines how data is clocked out and in. This may be changed by the device's driver. The "active low" default for chipselect mode can be overridden (by specifying SPI_CS_HIGH) as can the "MSB first" default for each word in a transfer (by specifying SPI_LSB_FIRST).h]hXThe spi mode defines how data is clocked out and in. This may be changed by the device’s driver. The “active low” default for chipselect mode can be overridden (by specifying SPI_CS_HIGH) as can the “MSB first” default for each word in a transfer (by specifying SPI_LSB_FIRST).}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(h```irq`` Negative, or the number passed to request_irq() to receive interrupts from this device. h](j)}(h``irq``h]h)}(hj. h]hirq}(hj0 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj, ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj( ubj)}(hhh]h)}(hWNegative, or the number passed to request_irq() to receive interrupts from this device.h]hWNegative, or the number passed to request_irq() to receive interrupts from this device.}(hjG hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjD ubah}(h]h ]h"]h$]h&]uh1jhj( ubeh}(h]h ]h"]h$]h&]uh1jhjC hKhjubj)}(h0``controller_state`` Controller's runtime state h](j)}(h``controller_state``h]h)}(hjh h]hcontroller_state}(hjj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjf ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjb ubj)}(hhh]h)}(hController's runtime stateh]hController’s runtime state}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj} hKhj~ ubah}(h]h ]h"]h$]h&]uh1jhjb ubeh}(h]h ]h"]h$]h&]uh1jhj} hKhjubj)}(h``controller_data`` Board-specific definitions for controller, such as FIFO initialization parameters; from board_info.controller_data h](j)}(h``controller_data``h]h)}(hj h]hcontroller_data}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubj)}(hhh]h)}(hrBoard-specific definitions for controller, such as FIFO initialization parameters; from board_info.controller_datah]hrBoard-specific definitions for controller, such as FIFO initialization parameters; from board_info.controller_data}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(h``modalias`` Name of the driver to use with this device, or an alias for that name. This appears in the sysfs "modalias" attribute for driver coldplugging, and in uevents used for hotplugging h](j)}(h ``modalias``h]h)}(hj h]hmodalias}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubj)}(hhh]h)}(hName of the driver to use with this device, or an alias for that name. This appears in the sysfs "modalias" attribute for driver coldplugging, and in uevents used for hotpluggingh]hName of the driver to use with this device, or an alias for that name. This appears in the sysfs “modalias” attribute for driver coldplugging, and in uevents used for hotplugging}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(h2``pcpu_statistics`` statistics for the spi_device h](j)}(h``pcpu_statistics``h]h)}(hj h]hpcpu_statistics}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubj)}(hhh]h)}(hstatistics for the spi_deviceh]hstatistics for the spi_device}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj* hKhj+ ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj* hKhjubj)}(hL``word_delay`` delay to be inserted between consecutive words of a transfer h](j)}(h``word_delay``h]h)}(hjN h]h word_delay}(hjP hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjL ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjH ubj)}(hhh]h)}(hchipselect[i] gives the corresponding physical CS for logical CS i. h](j)}(h``chip_select``h]h)}(hj h]h chip_select}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubj)}(hhh]h)}(hfArray of physical chipselect, spi->chipselect[i] gives the corresponding physical CS for logical CS i.h]hfArray of physical chipselect, spi->chipselect[i] gives the corresponding physical CS for logical CS i.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(h8``num_chipselect`` Number of physical chipselects used. h](j)}(h``num_chipselect``h]h)}(hj h]hnum_chipselect}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubj)}(hhh]h)}(h$Number of physical chipselects used.h]h$Number of physical chipselects used.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hKhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hKhjubj)}(hO``cs_index_mask`` Bit mask of the active chipselect(s) in the chipselect array h](j)}(h``cs_index_mask``h]h)}(hj h]h cs_index_mask}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj ubj)}(hhh]h)}(h h]hcs_gpiod}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj< ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj8 ubj)}(hhh]h)}(hkArray of GPIO descriptors of the corresponding chipselect lines (optional, NULL when not using a GPIO line)h]hkArray of GPIO descriptors of the corresponding chipselect lines (optional, NULL when not using a GPIO line)}(hjW hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjT ubah}(h]h ]h"]h$]h&]uh1jhj8 ubeh}(h]h ]h"]h$]h&]uh1jhjS hKhjubj)}(hM``tx_lane_map`` Map of peripheral lanes (index) to controller lanes (value). h](j)}(h``tx_lane_map``h]h)}(hjx h]h tx_lane_map}(hjz hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjv ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhjr ubj)}(hhh]h)}(hubah}(h]h ]h"]h$]h&]uh1jhj"ubh)}(h **Context**h]j)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubh)}(h can sleeph]h can sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jmodule_spi_driver (C macro)c.module_spi_driverhNtauh1jhhhhhjhNubj)}(hhh](j)}(hmodule_spi_driverh]j)}(hmodule_spi_driverh]j$)}(hmodule_spi_driverh]j*)}(hjh]hmodule_spi_driver}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubah}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhjhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjhhubjX)}(hhh]h}(h]h ]h"]h$]h&]uh1jWhjhhhjhMubeh}(h]h ](jmacroeh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhjhNubh)}(h$``module_spi_driver (__spi_driver)``h]h)}(hjh]h module_spi_driver (__spi_driver)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh block_quote)}(h*Helper macro for registering a SPI driver h]h)}(h)Helper macro for registering a SPI driverh]h)Helper macro for registering a SPI driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhj'hMhhhhubj)}(hX!**Parameters** ``__spi_driver`` spi_driver struct **Description** Helper macro for SPI drivers which do not do anything special in module init/exit. This eliminates a lot of boilerplate. Each module may only use this macro once, and calling it replaces module_init() and module_exit()h](h)}(h**Parameters**h]j)}(hj4h]h Parameters}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj.ubj)}(hhh]j)}(h#``__spi_driver`` spi_driver struct h](j)}(h``__spi_driver``h]h)}(hjSh]h __spi_driver}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjMubj)}(hhh]h)}(hspi_driver structh]hspi_driver struct}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhMhjiubah}(h]h ]h"]h$]h&]uh1jhjMubeh}(h]h ]h"]h$]h&]uh1jhjhhMhjJubah}(h]h ]h"]h$]h&]uh1jhj.ubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj.ubh)}(hHelper macro for SPI drivers which do not do anything special in module init/exit. This eliminates a lot of boilerplate. Each module may only use this macro once, and calling it replaces module_init() and module_exit()h]hHelper macro for SPI drivers which do not do anything special in module init/exit. This eliminates a lot of boilerplate. Each module may only use this macro once, and calling it replaces module_init() and module_exit()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj.ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_controller (C struct)c.spi_controllerhNtauh1jhhhhhjhNubj)}(hhh](j)}(hspi_controllerh]j)}(hstruct spi_controllerh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj$)}(hspi_controllerh]j*)}(hjh]hspi_controller}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjhhhjhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhjhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjhhubjX)}(hhh]h)}(h*interface to SPI host or target controllerh]h*interface to SPI host or target controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjhhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjhMubeh}(h]h ](jstructeh"]h$]h&]jxjjyj-jzj-j{j|j}uh1jhhhhhjhNubj)}(hX2**Definition**:: struct spi_controller { struct device dev; struct list_head list; s16 bus_num; u16 num_chipselect; u16 num_data_lanes; u16 dma_alignment; u32 mode_bits; u32 buswidth_override_bits; u32 bits_per_word_mask; #define SPI_BPW_MASK(bits) BIT((bits) - 1); #define SPI_BPW_RANGE_MASK(min, max) GENMASK((max) - 1, (min) - 1); u32 min_speed_hz; u32 max_speed_hz; u16 flags; #define SPI_CONTROLLER_HALF_DUPLEX BIT(0) ; #define SPI_CONTROLLER_NO_RX BIT(1) ; #define SPI_CONTROLLER_NO_TX BIT(2) ; #define SPI_CONTROLLER_MUST_RX BIT(3) ; #define SPI_CONTROLLER_MUST_TX BIT(4) ; #define SPI_CONTROLLER_GPIO_SS BIT(5) ; #define SPI_CONTROLLER_SUSPENDED BIT(6) ; #define SPI_CONTROLLER_MULTI_CS BIT(7); union { bool slave; bool target; }; size_t (*max_transfer_size)(struct spi_device *spi); size_t (*max_message_size)(struct spi_device *spi); struct mutex io_mutex; struct mutex add_lock; spinlock_t bus_lock_spinlock; struct mutex bus_lock_mutex; bool bus_lock_flag; int (*setup)(struct spi_device *spi); int (*set_cs_timing)(struct spi_device *spi); int (*transfer)(struct spi_device *spi, struct spi_message *mesg); void (*cleanup)(struct spi_device *spi); bool (*can_dma)(struct spi_controller *ctlr, struct spi_device *spi, struct spi_transfer *xfer); struct device *dma_map_dev; struct device *cur_rx_dma_dev; struct device *cur_tx_dma_dev; bool queued; struct kthread_worker *kworker; struct kthread_work pump_messages; spinlock_t queue_lock; struct list_head queue; struct spi_message *cur_msg; struct completion cur_msg_completion; bool cur_msg_incomplete; bool cur_msg_need_completion; bool busy; bool running; bool rt; bool auto_runtime_pm; bool fallback; bool last_cs_mode_high; s8 last_cs[SPI_DEVICE_CS_CNT_MAX]; u32 last_cs_index_mask : SPI_DEVICE_CS_CNT_MAX; struct completion xfer_completion; size_t max_dma_len; int (*optimize_message)(struct spi_message *msg); int (*unoptimize_message)(struct spi_message *msg); int (*prepare_transfer_hardware)(struct spi_controller *ctlr); int (*transfer_one_message)(struct spi_controller *ctlr, struct spi_message *mesg); int (*unprepare_transfer_hardware)(struct spi_controller *ctlr); int (*prepare_message)(struct spi_controller *ctlr, struct spi_message *message); int (*unprepare_message)(struct spi_controller *ctlr, struct spi_message *message); int (*target_abort)(struct spi_controller *ctlr); void (*set_cs)(struct spi_device *spi, bool enable); int (*transfer_one)(struct spi_controller *ctlr, struct spi_device *spi, struct spi_transfer *transfer); void (*handle_err)(struct spi_controller *ctlr, struct spi_message *message); const struct spi_controller_mem_ops *mem_ops; const struct spi_controller_mem_caps *mem_caps; bool dtr_caps; struct spi_offload *(*get_offload)(struct spi_device *spi, const struct spi_offload_config *config); void (*put_offload)(struct spi_offload *offload); struct gpio_desc **cs_gpiods; bool use_gpio_descriptors; s8 unused_native_cs; s8 max_native_cs; struct spi_statistics __percpu *pcpu_statistics; struct dma_chan *dma_tx; struct dma_chan *dma_rx; void *dummy_rx; void *dummy_tx; int (*fw_translate_cs)(struct spi_controller *ctlr, unsigned cs); bool ptp_sts_supported; unsigned long irq_flags; bool queue_empty; bool must_async; bool defer_optimize_message; #if IS_ENABLED(CONFIG_SPI_DYNAMIC); struct list_head userspace_clients; bool userspace_registered; #endif; }; **Members** ``dev`` device interface to this driver ``list`` link with the global spi_controller list ``bus_num`` board-specific (and often SOC-specific) identifier for a given SPI controller. ``num_chipselect`` chipselects are used to distinguish individual SPI targets, and are numbered from zero to num_chipselects. each target has a chipselect signal, but it's common that not every chipselect is connected to a target. ``num_data_lanes`` Number of data lanes supported by this controller. Default is 1. ``dma_alignment`` SPI controller constraint on DMA buffers alignment. ``mode_bits`` flags understood by this controller driver ``buswidth_override_bits`` flags to override for this controller driver ``bits_per_word_mask`` A mask indicating which values of bits_per_word are supported by the driver. Bit n indicates that a bits_per_word n+1 is supported. If set, the SPI core will reject any transfer with an unsupported bits_per_word. If not set, this value is simply ignored, and it's up to the individual driver to perform any validation. ``min_speed_hz`` Lowest supported transfer speed ``max_speed_hz`` Highest supported transfer speed ``flags`` other constraints relevant to this driver ``{unnamed_union}`` anonymous ``slave`` indicates that this is an SPI slave controller ``target`` indicates that this is an SPI target controller ``max_transfer_size`` function that returns the max transfer size for a :c:type:`spi_device`; may be ``NULL``, so the default ``SIZE_MAX`` will be used. ``max_message_size`` function that returns the max message size for a :c:type:`spi_device`; may be ``NULL``, so the default ``SIZE_MAX`` will be used. ``io_mutex`` mutex for physical bus access ``add_lock`` mutex to avoid adding devices to the same chipselect ``bus_lock_spinlock`` spinlock for SPI bus locking ``bus_lock_mutex`` mutex for exclusion of multiple callers ``bus_lock_flag`` indicates that the SPI bus is locked for exclusive use ``setup`` updates the device mode and clocking records used by a device's SPI controller; protocol code may call this. This must fail if an unrecognized or unsupported mode is requested. It's always safe to call this unless transfers are pending on the device whose settings are being modified. ``set_cs_timing`` optional hook for SPI devices to request SPI controller for configuring specific CS setup time, hold time and inactive delay in terms of clock counts ``transfer`` adds a message to the controller's transfer queue. ``cleanup`` frees controller-specific state ``can_dma`` determine whether this controller supports DMA ``dma_map_dev`` device which can be used for DMA mapping ``cur_rx_dma_dev`` device which is currently used for RX DMA mapping ``cur_tx_dma_dev`` device which is currently used for TX DMA mapping ``queued`` whether this controller is providing an internal message queue ``kworker`` pointer to thread struct for message pump ``pump_messages`` work struct for scheduling work to the message pump ``queue_lock`` spinlock to synchronise access to message queue ``queue`` message queue ``cur_msg`` the currently in-flight message ``cur_msg_completion`` a completion for the current in-flight message ``cur_msg_incomplete`` Flag used internally to opportunistically skip the **cur_msg_completion**. This flag is used to check if the driver has already called spi_finalize_current_message(). ``cur_msg_need_completion`` Flag used internally to opportunistically skip the **cur_msg_completion**. This flag is used to signal the context that is running spi_finalize_current_message() that it needs to complete() ``busy`` message pump is busy ``running`` message pump is running ``rt`` whether this queue is set to run as a realtime task ``auto_runtime_pm`` the core should ensure a runtime PM reference is held while the hardware is prepared, using the parent device for the spidev ``fallback`` fallback to PIO if DMA transfer return failure with SPI_TRANS_FAIL_NO_START. ``last_cs_mode_high`` was (mode & SPI_CS_HIGH) true on the last call to set_cs. ``last_cs`` the last chip_select that is recorded by set_cs, -1 on non chip selected ``last_cs_index_mask`` bit mask the last chip selects that were used ``xfer_completion`` used by core transfer_one_message() ``max_dma_len`` Maximum length of a DMA transfer for the device. ``optimize_message`` optimize the message for reuse ``unoptimize_message`` release resources allocated by optimize_message ``prepare_transfer_hardware`` a message will soon arrive from the queue so the subsystem requests the driver to prepare the transfer hardware by issuing this call ``transfer_one_message`` the subsystem calls the driver to transfer a single message while queuing transfers that arrive in the meantime. When the driver is finished with this message, it must call spi_finalize_current_message() so the subsystem can issue the next message ``unprepare_transfer_hardware`` there are currently no more messages on the queue so the subsystem notifies the driver that it may relax the hardware by issuing this call ``prepare_message`` set up the controller to transfer a single message, for example doing DMA mapping. Called from threaded context. ``unprepare_message`` undo any work done by prepare_message(). ``target_abort`` abort the ongoing transfer request on an SPI target controller ``set_cs`` set the logic level of the chip select line. May be called from interrupt context. ``transfer_one`` transfer a single spi_transfer. ``handle_err`` the subsystem calls the driver to handle an error that occurs in the generic implementation of transfer_one_message(). ``mem_ops`` optimized/dedicated operations for interactions with SPI memory. This field is optional and should only be implemented if the controller has native support for memory like operations. ``mem_caps`` controller capabilities for the handling of memory operations. ``dtr_caps`` true if controller has dtr(single/dual transfer rate) capability. QSPI based controller should fill this based on controller's capability. ``get_offload`` callback for controllers with offload support to get matching offload instance. Implementations should return -ENODEV if no match is found. ``put_offload`` release the offload instance acquired by **get_offload**. ``cs_gpiods`` Array of GPIO descriptors to use as chip select lines; one per CS number. Any individual value may be NULL for CS lines that are not GPIOs (driven by the SPI controller itself). ``use_gpio_descriptors`` Turns on the code in the SPI core to parse and grab GPIO descriptors. This will fill in **cs_gpiods** and SPI devices will have the cs_gpiod assigned if a GPIO line is found for the chipselect. ``unused_native_cs`` When cs_gpiods is used, spi_register_controller() will fill in this field with the first unused native CS, to be used by SPI controller drivers that need to drive a native CS when using GPIO CS. ``max_native_cs`` When cs_gpiods is used, and this field is filled in, spi_register_controller() will validate all native CS (including the unused native CS) against this value. ``pcpu_statistics`` statistics for the spi_controller ``dma_tx`` DMA transmit channel ``dma_rx`` DMA receive channel ``dummy_rx`` dummy receive buffer for full-duplex devices ``dummy_tx`` dummy transmit buffer for full-duplex devices ``fw_translate_cs`` If the boot firmware uses different numbering scheme what Linux expects, this optional hook can be used to translate between the two. ``ptp_sts_supported`` If the driver sets this to true, it must provide a time snapshot in **spi_transfer->ptp_sts** as close as possible to the moment in time when **spi_transfer->ptp_sts_word_pre** and **spi_transfer->ptp_sts_word_post** were transmitted. If the driver does not set this, the SPI core takes the snapshot as close to the driver hand-over as possible. ``irq_flags`` Interrupt enable state during PTP system timestamping ``queue_empty`` signal green light for opportunistically skipping the queue for spi_sync transfers. ``must_async`` disable all fast paths in the core ``defer_optimize_message`` set to true if controller cannot pre-optimize messages and needs to defer the optimization step until the message is actually being transferred ``userspace_clients`` list of SPI devices instantiated from userspace via the sysfs new_device interface; protected by **add_lock** ``userspace_registered`` true once the new_device/delete_device sysfs group has been added by spi_register_controller(); used by spi_unregister_controller() to know whether to remove ith](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj5ubh:}(hj5hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj1ubj)}(hXTstruct spi_controller { struct device dev; struct list_head list; s16 bus_num; u16 num_chipselect; u16 num_data_lanes; u16 dma_alignment; u32 mode_bits; u32 buswidth_override_bits; u32 bits_per_word_mask; #define SPI_BPW_MASK(bits) BIT((bits) - 1); #define SPI_BPW_RANGE_MASK(min, max) GENMASK((max) - 1, (min) - 1); u32 min_speed_hz; u32 max_speed_hz; u16 flags; #define SPI_CONTROLLER_HALF_DUPLEX BIT(0) ; #define SPI_CONTROLLER_NO_RX BIT(1) ; #define SPI_CONTROLLER_NO_TX BIT(2) ; #define SPI_CONTROLLER_MUST_RX BIT(3) ; #define SPI_CONTROLLER_MUST_TX BIT(4) ; #define SPI_CONTROLLER_GPIO_SS BIT(5) ; #define SPI_CONTROLLER_SUSPENDED BIT(6) ; #define SPI_CONTROLLER_MULTI_CS BIT(7); union { bool slave; bool target; }; size_t (*max_transfer_size)(struct spi_device *spi); size_t (*max_message_size)(struct spi_device *spi); struct mutex io_mutex; struct mutex add_lock; spinlock_t bus_lock_spinlock; struct mutex bus_lock_mutex; bool bus_lock_flag; int (*setup)(struct spi_device *spi); int (*set_cs_timing)(struct spi_device *spi); int (*transfer)(struct spi_device *spi, struct spi_message *mesg); void (*cleanup)(struct spi_device *spi); bool (*can_dma)(struct spi_controller *ctlr, struct spi_device *spi, struct spi_transfer *xfer); struct device *dma_map_dev; struct device *cur_rx_dma_dev; struct device *cur_tx_dma_dev; bool queued; struct kthread_worker *kworker; struct kthread_work pump_messages; spinlock_t queue_lock; struct list_head queue; struct spi_message *cur_msg; struct completion cur_msg_completion; bool cur_msg_incomplete; bool cur_msg_need_completion; bool busy; bool running; bool rt; bool auto_runtime_pm; bool fallback; bool last_cs_mode_high; s8 last_cs[SPI_DEVICE_CS_CNT_MAX]; u32 last_cs_index_mask : SPI_DEVICE_CS_CNT_MAX; struct completion xfer_completion; size_t max_dma_len; int (*optimize_message)(struct spi_message *msg); int (*unoptimize_message)(struct spi_message *msg); int (*prepare_transfer_hardware)(struct spi_controller *ctlr); int (*transfer_one_message)(struct spi_controller *ctlr, struct spi_message *mesg); int (*unprepare_transfer_hardware)(struct spi_controller *ctlr); int (*prepare_message)(struct spi_controller *ctlr, struct spi_message *message); int (*unprepare_message)(struct spi_controller *ctlr, struct spi_message *message); int (*target_abort)(struct spi_controller *ctlr); void (*set_cs)(struct spi_device *spi, bool enable); int (*transfer_one)(struct spi_controller *ctlr, struct spi_device *spi, struct spi_transfer *transfer); void (*handle_err)(struct spi_controller *ctlr, struct spi_message *message); const struct spi_controller_mem_ops *mem_ops; const struct spi_controller_mem_caps *mem_caps; bool dtr_caps; struct spi_offload *(*get_offload)(struct spi_device *spi, const struct spi_offload_config *config); void (*put_offload)(struct spi_offload *offload); struct gpio_desc **cs_gpiods; bool use_gpio_descriptors; s8 unused_native_cs; s8 max_native_cs; struct spi_statistics __percpu *pcpu_statistics; struct dma_chan *dma_tx; struct dma_chan *dma_rx; void *dummy_rx; void *dummy_tx; int (*fw_translate_cs)(struct spi_controller *ctlr, unsigned cs); bool ptp_sts_supported; unsigned long irq_flags; bool queue_empty; bool must_async; bool defer_optimize_message; #if IS_ENABLED(CONFIG_SPI_DYNAMIC); struct list_head userspace_clients; bool userspace_registered; #endif; };h]hXTstruct spi_controller { struct device dev; struct list_head list; s16 bus_num; u16 num_chipselect; u16 num_data_lanes; u16 dma_alignment; u32 mode_bits; u32 buswidth_override_bits; u32 bits_per_word_mask; #define SPI_BPW_MASK(bits) BIT((bits) - 1); #define SPI_BPW_RANGE_MASK(min, max) GENMASK((max) - 1, (min) - 1); u32 min_speed_hz; u32 max_speed_hz; u16 flags; #define SPI_CONTROLLER_HALF_DUPLEX BIT(0) ; #define SPI_CONTROLLER_NO_RX BIT(1) ; #define SPI_CONTROLLER_NO_TX BIT(2) ; #define SPI_CONTROLLER_MUST_RX BIT(3) ; #define SPI_CONTROLLER_MUST_TX BIT(4) ; #define SPI_CONTROLLER_GPIO_SS BIT(5) ; #define SPI_CONTROLLER_SUSPENDED BIT(6) ; #define SPI_CONTROLLER_MULTI_CS BIT(7); union { bool slave; bool target; }; size_t (*max_transfer_size)(struct spi_device *spi); size_t (*max_message_size)(struct spi_device *spi); struct mutex io_mutex; struct mutex add_lock; spinlock_t bus_lock_spinlock; struct mutex bus_lock_mutex; bool bus_lock_flag; int (*setup)(struct spi_device *spi); int (*set_cs_timing)(struct spi_device *spi); int (*transfer)(struct spi_device *spi, struct spi_message *mesg); void (*cleanup)(struct spi_device *spi); bool (*can_dma)(struct spi_controller *ctlr, struct spi_device *spi, struct spi_transfer *xfer); struct device *dma_map_dev; struct device *cur_rx_dma_dev; struct device *cur_tx_dma_dev; bool queued; struct kthread_worker *kworker; struct kthread_work pump_messages; spinlock_t queue_lock; struct list_head queue; struct spi_message *cur_msg; struct completion cur_msg_completion; bool cur_msg_incomplete; bool cur_msg_need_completion; bool busy; bool running; bool rt; bool auto_runtime_pm; bool fallback; bool last_cs_mode_high; s8 last_cs[SPI_DEVICE_CS_CNT_MAX]; u32 last_cs_index_mask : SPI_DEVICE_CS_CNT_MAX; struct completion xfer_completion; size_t max_dma_len; int (*optimize_message)(struct spi_message *msg); int (*unoptimize_message)(struct spi_message *msg); int (*prepare_transfer_hardware)(struct spi_controller *ctlr); int (*transfer_one_message)(struct spi_controller *ctlr, struct spi_message *mesg); int (*unprepare_transfer_hardware)(struct spi_controller *ctlr); int (*prepare_message)(struct spi_controller *ctlr, struct spi_message *message); int (*unprepare_message)(struct spi_controller *ctlr, struct spi_message *message); int (*target_abort)(struct spi_controller *ctlr); void (*set_cs)(struct spi_device *spi, bool enable); int (*transfer_one)(struct spi_controller *ctlr, struct spi_device *spi, struct spi_transfer *transfer); void (*handle_err)(struct spi_controller *ctlr, struct spi_message *message); const struct spi_controller_mem_ops *mem_ops; const struct spi_controller_mem_caps *mem_caps; bool dtr_caps; struct spi_offload *(*get_offload)(struct spi_device *spi, const struct spi_offload_config *config); void (*put_offload)(struct spi_offload *offload); struct gpio_desc **cs_gpiods; bool use_gpio_descriptors; s8 unused_native_cs; s8 max_native_cs; struct spi_statistics __percpu *pcpu_statistics; struct dma_chan *dma_tx; struct dma_chan *dma_rx; void *dummy_rx; void *dummy_tx; int (*fw_translate_cs)(struct spi_controller *ctlr, unsigned cs); bool ptp_sts_supported; unsigned long irq_flags; bool queue_empty; bool must_async; bool defer_optimize_message; #if IS_ENABLED(CONFIG_SPI_DYNAMIC); struct list_head userspace_clients; bool userspace_registered; #endif; };}hjRsbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj1ubh)}(h **Members**h]j)}(hjch]hMembers}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1jhjaubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj1ubj)}(hhh](j)}(h(``dev`` device interface to this driver h](j)}(h``dev``h]h)}(hjh]hdev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj|ubj)}(hhh]h)}(hdevice interface to this driverh]hdevice interface to this driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h2``list`` link with the global spi_controller list h](j)}(h``list``h]h)}(hjh]hlist}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h(link with the global spi_controller listh]h(link with the global spi_controller list}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h[``bus_num`` board-specific (and often SOC-specific) identifier for a given SPI controller. h](j)}(h ``bus_num``h]h)}(hjh]hbus_num}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hNboard-specific (and often SOC-specific) identifier for a given SPI controller.h]hNboard-specific (and often SOC-specific) identifier for a given SPI controller.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj hMhjyubj)}(h``num_chipselect`` chipselects are used to distinguish individual SPI targets, and are numbered from zero to num_chipselects. each target has a chipselect signal, but it's common that not every chipselect is connected to a target. h](j)}(h``num_chipselect``h]h)}(hj.h]hnum_chipselect}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj(ubj)}(hhh]h)}(hchipselects are used to distinguish individual SPI targets, and are numbered from zero to num_chipselects. each target has a chipselect signal, but it's common that not every chipselect is connected to a target.h]hchipselects are used to distinguish individual SPI targets, and are numbered from zero to num_chipselects. each target has a chipselect signal, but it’s common that not every chipselect is connected to a target.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjDubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhjChMhjyubj)}(hT``num_data_lanes`` Number of data lanes supported by this controller. Default is 1. h](j)}(h``num_data_lanes``h]h)}(hjhh]hnum_data_lanes}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjfubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjbubj)}(hhh]h)}(h@Number of data lanes supported by this controller. Default is 1.h]h@Number of data lanes supported by this controller. Default is 1.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj}hMhj~ubah}(h]h ]h"]h$]h&]uh1jhjbubeh}(h]h ]h"]h$]h&]uh1jhj}hMhjyubj)}(hF``dma_alignment`` SPI controller constraint on DMA buffers alignment. h](j)}(h``dma_alignment``h]h)}(hjh]h dma_alignment}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h3SPI controller constraint on DMA buffers alignment.h]h3SPI controller constraint on DMA buffers alignment.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h9``mode_bits`` flags understood by this controller driver h](j)}(h ``mode_bits``h]h)}(hjh]h mode_bits}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h*flags understood by this controller driverh]h*flags understood by this controller driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hH``buswidth_override_bits`` flags to override for this controller driver h](j)}(h``buswidth_override_bits``h]h)}(hjh]hbuswidth_override_bits}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj ubj)}(hhh]h)}(h,flags to override for this controller driverh]h,flags to override for this controller driver}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hMhj)ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj(hMhjyubj)}(hXV``bits_per_word_mask`` A mask indicating which values of bits_per_word are supported by the driver. Bit n indicates that a bits_per_word n+1 is supported. If set, the SPI core will reject any transfer with an unsupported bits_per_word. If not set, this value is simply ignored, and it's up to the individual driver to perform any validation. h](j)}(h``bits_per_word_mask``h]h)}(hjLh]hbits_per_word_mask}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjFubj)}(hhh]h)}(hX>A mask indicating which values of bits_per_word are supported by the driver. Bit n indicates that a bits_per_word n+1 is supported. If set, the SPI core will reject any transfer with an unsupported bits_per_word. If not set, this value is simply ignored, and it's up to the individual driver to perform any validation.h]hX@A mask indicating which values of bits_per_word are supported by the driver. Bit n indicates that a bits_per_word n+1 is supported. If set, the SPI core will reject any transfer with an unsupported bits_per_word. If not set, this value is simply ignored, and it’s up to the individual driver to perform any validation.}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjbubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhjahMhjyubj)}(h1``min_speed_hz`` Lowest supported transfer speed h](j)}(h``min_speed_hz``h]h)}(hjh]h min_speed_hz}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hLowest supported transfer speedh]hLowest supported transfer speed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h2``max_speed_hz`` Highest supported transfer speed h](j)}(h``max_speed_hz``h]h)}(hjh]h max_speed_hz}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h Highest supported transfer speedh]h Highest supported transfer speed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h4``flags`` other constraints relevant to this driver h](j)}(h ``flags``h]h)}(hjh]hflags}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h)other constraints relevant to this driverh]h)other constraints relevant to this driver}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj hMhjyubj)}(h``{unnamed_union}`` anonymous h](j)}(h``{unnamed_union}``h]h)}(hj1h]h{unnamed_union}}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhKhj+ubj)}(hhh]h)}(h anonymoush]h anonymous}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhKhjGubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]uh1jhjFhKhjyubj)}(h9``slave`` indicates that this is an SPI slave controller h](j)}(h ``slave``h]h)}(hjjh]hslave}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjdubj)}(hhh]h)}(h.indicates that this is an SPI slave controllerh]h.indicates that this is an SPI slave controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h;``target`` indicates that this is an SPI target controller h](j)}(h ``target``h]h)}(hjh]htarget}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h/indicates that this is an SPI target controllerh]h/indicates that this is an SPI target controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h``max_transfer_size`` function that returns the max transfer size for a :c:type:`spi_device`; may be ``NULL``, so the default ``SIZE_MAX`` will be used. h](j)}(h``max_transfer_size``h]h)}(hjh]hmax_transfer_size}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hfunction that returns the max transfer size for a :c:type:`spi_device`; may be ``NULL``, so the default ``SIZE_MAX`` will be used.h](h2function that returns the max transfer size for a }(hjhhhNhNubh)}(h:c:type:`spi_device`h]h)}(hjh]h spi_device}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjj)}j]sbj spi_deviceuh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubh ; may be }(hjhhhNhNubh)}(h``NULL``h]hNULL}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh, so the default }(hjhhhNhNubh)}(h ``SIZE_MAX``h]hSIZE_MAX}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubh will be used.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h``max_message_size`` function that returns the max message size for a :c:type:`spi_device`; may be ``NULL``, so the default ``SIZE_MAX`` will be used. h](j)}(h``max_message_size``h]h)}(hj`h]hmax_message_size}(hjbhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjZubj)}(hhh]h)}(hfunction that returns the max message size for a :c:type:`spi_device`; may be ``NULL``, so the default ``SIZE_MAX`` will be used.h](h1function that returns the max message size for a }(hjyhhhNhNubh)}(h:c:type:`spi_device`h]h)}(hjh]h spi_device}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnjjj spi_deviceuh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjyubh ; may be }(hjyhhhNhNubh)}(h``NULL``h]hNULL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyubh, so the default }(hjyhhhNhNubh)}(h ``SIZE_MAX``h]hSIZE_MAX}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyubh will be used.}(hjyhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhMhjvubah}(h]h ]h"]h$]h&]uh1jhjZubeh}(h]h ]h"]h$]h&]uh1jhjuhMhjyubj)}(h+``io_mutex`` mutex for physical bus access h](j)}(h ``io_mutex``h]h)}(hjh]hio_mutex}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hmutex for physical bus accessh]hmutex for physical bus access}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hB``add_lock`` mutex to avoid adding devices to the same chipselect h](j)}(h ``add_lock``h]h)}(hjh]hadd_lock}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h4mutex to avoid adding devices to the same chipselecth]h4mutex to avoid adding devices to the same chipselect}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hMhj0ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj/hMhjyubj)}(h3``bus_lock_spinlock`` spinlock for SPI bus locking h](j)}(h``bus_lock_spinlock``h]h)}(hjSh]hbus_lock_spinlock}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjMubj)}(hhh]h)}(hspinlock for SPI bus lockingh]hspinlock for SPI bus locking}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhMhjiubah}(h]h ]h"]h$]h&]uh1jhjMubeh}(h]h ]h"]h$]h&]uh1jhjhhMhjyubj)}(h;``bus_lock_mutex`` mutex for exclusion of multiple callers h](j)}(h``bus_lock_mutex``h]h)}(hjh]hbus_lock_mutex}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h'mutex for exclusion of multiple callersh]h'mutex for exclusion of multiple callers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hI``bus_lock_flag`` indicates that the SPI bus is locked for exclusive use h](j)}(h``bus_lock_flag``h]h)}(hjh]h bus_lock_flag}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h6indicates that the SPI bus is locked for exclusive useh]h6indicates that the SPI bus is locked for exclusive use}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hX(``setup`` updates the device mode and clocking records used by a device's SPI controller; protocol code may call this. This must fail if an unrecognized or unsupported mode is requested. It's always safe to call this unless transfers are pending on the device whose settings are being modified. h](j)}(h ``setup``h]h)}(hjh]hsetup}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hXupdates the device mode and clocking records used by a device's SPI controller; protocol code may call this. This must fail if an unrecognized or unsupported mode is requested. It's always safe to call this unless transfers are pending on the device whose settings are being modified.h]hX!updates the device mode and clocking records used by a device’s SPI controller; protocol code may call this. This must fail if an unrecognized or unsupported mode is requested. It’s always safe to call this unless transfers are pending on the device whose settings are being modified.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h``set_cs_timing`` optional hook for SPI devices to request SPI controller for configuring specific CS setup time, hold time and inactive delay in terms of clock counts h](j)}(h``set_cs_timing``h]h)}(hj8h]h set_cs_timing}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj2ubj)}(hhh]h)}(hoptional hook for SPI devices to request SPI controller for configuring specific CS setup time, hold time and inactive delay in terms of clock countsh]hoptional hook for SPI devices to request SPI controller for configuring specific CS setup time, hold time and inactive delay in terms of clock counts}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjNubah}(h]h ]h"]h$]h&]uh1jhj2ubeh}(h]h ]h"]h$]h&]uh1jhjMhMhjyubj)}(h@``transfer`` adds a message to the controller's transfer queue. h](j)}(h ``transfer``h]h)}(hjrh]htransfer}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjpubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjlubj)}(hhh]h)}(h2adds a message to the controller's transfer queue.h]h4adds a message to the controller’s transfer queue.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjlubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h,``cleanup`` frees controller-specific state h](j)}(h ``cleanup``h]h)}(hjh]hcleanup}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hfrees controller-specific stateh]hfrees controller-specific state}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h;``can_dma`` determine whether this controller supports DMA h](j)}(h ``can_dma``h]h)}(hjh]hcan_dma}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h.determine whether this controller supports DMAh]h.determine whether this controller supports DMA}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h9``dma_map_dev`` device which can be used for DMA mapping h](j)}(h``dma_map_dev``h]h)}(hjh]h dma_map_dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h(device which can be used for DMA mappingh]h(device which can be used for DMA mapping}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2hMhj3ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj2hMhjyubj)}(hE``cur_rx_dma_dev`` device which is currently used for RX DMA mapping h](j)}(h``cur_rx_dma_dev``h]h)}(hjVh]hcur_rx_dma_dev}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjTubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjPubj)}(hhh]h)}(h1device which is currently used for RX DMA mappingh]h1device which is currently used for RX DMA mapping}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhMhjlubah}(h]h ]h"]h$]h&]uh1jhjPubeh}(h]h ]h"]h$]h&]uh1jhjkhMhjyubj)}(hE``cur_tx_dma_dev`` device which is currently used for TX DMA mapping h](j)}(h``cur_tx_dma_dev``h]h)}(hjh]hcur_tx_dma_dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h1device which is currently used for TX DMA mappingh]h1device which is currently used for TX DMA mapping}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hJ``queued`` whether this controller is providing an internal message queue h](j)}(h ``queued``h]h)}(hjh]hqueued}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h>whether this controller is providing an internal message queueh]h>whether this controller is providing an internal message queue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h6``kworker`` pointer to thread struct for message pump h](j)}(h ``kworker``h]h)}(hjh]hkworker}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h)pointer to thread struct for message pumph]h)pointer to thread struct for message pump}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hF``pump_messages`` work struct for scheduling work to the message pump h](j)}(h``pump_messages``h]h)}(hj:h]h pump_messages}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj4ubj)}(hhh]h)}(h3work struct for scheduling work to the message pumph]h3work struct for scheduling work to the message pump}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOhMhjPubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhjOhMhjyubj)}(h?``queue_lock`` spinlock to synchronise access to message queue h](j)}(h``queue_lock``h]h)}(hjsh]h queue_lock}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjmubj)}(hhh]h)}(h/spinlock to synchronise access to message queueh]h/spinlock to synchronise access to message queue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjmubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h``queue`` message queue h](j)}(h ``queue``h]h)}(hjh]hqueue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h message queueh]h message queue}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h,``cur_msg`` the currently in-flight message h](j)}(h ``cur_msg``h]h)}(hjh]hcur_msg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hthe currently in-flight messageh]hthe currently in-flight message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hF``cur_msg_completion`` a completion for the current in-flight message h](j)}(h``cur_msg_completion``h]h)}(hjh]hcur_msg_completion}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h.a completion for the current in-flight messageh]h.a completion for the current in-flight message}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3hMhj4ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj3hMhjyubj)}(h``cur_msg_incomplete`` Flag used internally to opportunistically skip the **cur_msg_completion**. This flag is used to check if the driver has already called spi_finalize_current_message(). h](j)}(h``cur_msg_incomplete``h]h)}(hjWh]hcur_msg_incomplete}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjQubj)}(hhh]h)}(hFlag used internally to opportunistically skip the **cur_msg_completion**. This flag is used to check if the driver has already called spi_finalize_current_message().h](h3Flag used internally to opportunistically skip the }(hjphhhNhNubj)}(h**cur_msg_completion**h]hcur_msg_completion}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubh]. This flag is used to check if the driver has already called spi_finalize_current_message().}(hjphhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjmubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]uh1jhjlhMhjyubj)}(h``cur_msg_need_completion`` Flag used internally to opportunistically skip the **cur_msg_completion**. This flag is used to signal the context that is running spi_finalize_current_message() that it needs to complete() h](j)}(h``cur_msg_need_completion``h]h)}(hjh]hcur_msg_need_completion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hFlag used internally to opportunistically skip the **cur_msg_completion**. This flag is used to signal the context that is running spi_finalize_current_message() that it needs to complete()h](h3Flag used internally to opportunistically skip the }(hjhhhNhNubj)}(h**cur_msg_completion**h]hcur_msg_completion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubht. This flag is used to signal the context that is running spi_finalize_current_message() that it needs to complete()}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h``busy`` message pump is busy h](j)}(h``busy``h]h)}(hjh]hbusy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hmessage pump is busyh]hmessage pump is busy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h$``running`` message pump is running h](j)}(h ``running``h]h)}(hj(h]hrunning}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubj)}(hhh]h)}(hmessage pump is runningh]hmessage pump is running}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hMhj>ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj=hMhjyubj)}(h;``rt`` whether this queue is set to run as a realtime task h](j)}(h``rt``h]h)}(hjah]hrt}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj[ubj)}(hhh]h)}(h3whether this queue is set to run as a realtime taskh]h3whether this queue is set to run as a realtime task}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjvhMhjwubah}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhjvhMhjyubj)}(h``auto_runtime_pm`` the core should ensure a runtime PM reference is held while the hardware is prepared, using the parent device for the spidev h](j)}(h``auto_runtime_pm``h]h)}(hjh]hauto_runtime_pm}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h|the core should ensure a runtime PM reference is held while the hardware is prepared, using the parent device for the spidevh]h|the core should ensure a runtime PM reference is held while the hardware is prepared, using the parent device for the spidev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hZ``fallback`` fallback to PIO if DMA transfer return failure with SPI_TRANS_FAIL_NO_START. h](j)}(h ``fallback``h]h)}(hjh]hfallback}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hLfallback to PIO if DMA transfer return failure with SPI_TRANS_FAIL_NO_START.h]hLfallback to PIO if DMA transfer return failure with SPI_TRANS_FAIL_NO_START.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hP``last_cs_mode_high`` was (mode & SPI_CS_HIGH) true on the last call to set_cs. h](j)}(h``last_cs_mode_high``h]h)}(hjh]hlast_cs_mode_high}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h9was (mode & SPI_CS_HIGH) true on the last call to set_cs.h]h9was (mode & SPI_CS_HIGH) true on the last call to set_cs.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hMhj$ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj#hMhjyubj)}(hU``last_cs`` the last chip_select that is recorded by set_cs, -1 on non chip selected h](j)}(h ``last_cs``h]h)}(hjGh]hlast_cs}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjEubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjAubj)}(hhh]h)}(hHthe last chip_select that is recorded by set_cs, -1 on non chip selectedh]hHthe last chip_select that is recorded by set_cs, -1 on non chip selected}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj]ubah}(h]h ]h"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]uh1jhj\hMhjyubj)}(hE``last_cs_index_mask`` bit mask the last chip selects that were used h](j)}(h``last_cs_index_mask``h]h)}(hjh]hlast_cs_index_mask}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj{ubj)}(hhh]h)}(h-bit mask the last chip selects that were usedh]h-bit mask the last chip selects that were used}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhj{ubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h8``xfer_completion`` used by core transfer_one_message() h](j)}(h``xfer_completion``h]h)}(hjh]hxfer_completion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h#used by core transfer_one_message()h]h#used by core transfer_one_message()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hA``max_dma_len`` Maximum length of a DMA transfer for the device. h](j)}(h``max_dma_len``h]h)}(hjh]h max_dma_len}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(h0Maximum length of a DMA transfer for the device.h]h0Maximum length of a DMA transfer for the device.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h4``optimize_message`` optimize the message for reuse h](j)}(h``optimize_message``h]h)}(hj,h]hoptimize_message}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj&ubj)}(hhh]h)}(hoptimize the message for reuseh]hoptimize the message for reuse}(hjEhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMhjBubah}(h]h ]h"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]uh1jhjAhMhjyubj)}(hG``unoptimize_message`` release resources allocated by optimize_message h](j)}(h``unoptimize_message``h]h)}(hjeh]hunoptimize_message}(hjghhhNhNubah}(h]h ]h"]h$]h&]uh1hhjcubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj_ubj)}(hhh]h)}(h/release resources allocated by optimize_messageh]h/release resources allocated by optimize_message}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjzhMhj{ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhjzhMhjyubj)}(h``prepare_transfer_hardware`` a message will soon arrive from the queue so the subsystem requests the driver to prepare the transfer hardware by issuing this call h](j)}(h``prepare_transfer_hardware``h]h)}(hjh]hprepare_transfer_hardware}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(ha message will soon arrive from the queue so the subsystem requests the driver to prepare the transfer hardware by issuing this callh]ha message will soon arrive from the queue so the subsystem requests the driver to prepare the transfer hardware by issuing this call}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(hX``transfer_one_message`` the subsystem calls the driver to transfer a single message while queuing transfers that arrive in the meantime. When the driver is finished with this message, it must call spi_finalize_current_message() so the subsystem can issue the next message h](j)}(h``transfer_one_message``h]h)}(hjh]htransfer_one_message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubj)}(hhh]h)}(hthe subsystem calls the driver to transfer a single message while queuing transfers that arrive in the meantime. When the driver is finished with this message, it must call spi_finalize_current_message() so the subsystem can issue the next messageh]hthe subsystem calls the driver to transfer a single message while queuing transfers that arrive in the meantime. When the driver is finished with this message, it must call spi_finalize_current_message() so the subsystem can issue the next message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjyubj)}(h``unprepare_transfer_hardware`` there are currently no more messages on the queue so the subsystem notifies the driver that it may relax the hardware by issuing this call h](j)}(h``unprepare_transfer_hardware``h]h)}(hj h]hunprepare_transfer_hardware}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj ubj)}(hhh]h)}(hthere are currently no more messages on the queue so the subsystem notifies the driver that it may relax the hardware by issuing this callh]hthere are currently no more messages on the queue so the subsystem notifies the driver that it may relax the hardware by issuing this call}(hj+ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj( ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj' hMhjyubj)}(h``prepare_message`` set up the controller to transfer a single message, for example doing DMA mapping. Called from threaded context. h](j)}(h``prepare_message``h]h)}(hjL h]hprepare_message}(hjN hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjJ ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjF ubj)}(hhh]h)}(hqset up the controller to transfer a single message, for example doing DMA mapping. Called from threaded context.h]hqset up the controller to transfer a single message, for example doing DMA mapping. Called from threaded context.}(hje hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjb ubah}(h]h ]h"]h$]h&]uh1jhjF ubeh}(h]h ]h"]h$]h&]uh1jhja hMhjyubj)}(h?``unprepare_message`` undo any work done by prepare_message(). h](j)}(h``unprepare_message``h]h)}(hj h]hunprepare_message}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj ubj)}(hhh]h)}(h(undo any work done by prepare_message().h]h(undo any work done by prepare_message().}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hMhjyubj)}(hP``target_abort`` abort the ongoing transfer request on an SPI target controller h](j)}(h``target_abort``h]h)}(hj h]h target_abort}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj ubj)}(hhh]h)}(h>abort the ongoing transfer request on an SPI target controllerh]h>abort the ongoing transfer request on an SPI target controller}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hMhj ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj hMhjyubj)}(h_``set_cs`` set the logic level of the chip select line. May be called from interrupt context. h](j)}(h ``set_cs``h]h)}(hj h]hset_cs}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj ubj)}(hhh]h)}(hSset the logic level of the chip select line. May be called from interrupt context.h]hSset the logic level of the chip select line. May be called from interrupt context.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj!ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]uh1jhj !hMhjyubj)}(h1``transfer_one`` transfer a single spi_transfer. h](j)}(h``transfer_one``h]h)}(hj2!h]h transfer_one}(hj4!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0!ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj,!ubj)}(hhh]h)}(htransfer a single spi_transfer.h]htransfer a single spi_transfer.}(hjK!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjG!hMhjH!ubah}(h]h ]h"]h$]h&]uh1jhj,!ubeh}(h]h ]h"]h$]h&]uh1jhjG!hMhjyubj)}(h``handle_err`` the subsystem calls the driver to handle an error that occurs in the generic implementation of transfer_one_message(). h](j)}(h``handle_err``h]h)}(hjk!h]h handle_err}(hjm!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhji!ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhje!ubj)}(hhh]h)}(hvthe subsystem calls the driver to handle an error that occurs in the generic implementation of transfer_one_message().h]hvthe subsystem calls the driver to handle an error that occurs in the generic implementation of transfer_one_message().}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj!ubah}(h]h ]h"]h$]h&]uh1jhje!ubeh}(h]h ]h"]h$]h&]uh1jhj!hMhjyubj)}(h``mem_ops`` optimized/dedicated operations for interactions with SPI memory. This field is optional and should only be implemented if the controller has native support for memory like operations. h](j)}(h ``mem_ops``h]h)}(hj!h]hmem_ops}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj!ubj)}(hhh]h)}(hoptimized/dedicated operations for interactions with SPI memory. This field is optional and should only be implemented if the controller has native support for memory like operations.h]hoptimized/dedicated operations for interactions with SPI memory. This field is optional and should only be implemented if the controller has native support for memory like operations.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj!ubah}(h]h ]h"]h$]h&]uh1jhj!ubeh}(h]h ]h"]h$]h&]uh1jhj!hMhjyubj)}(hL``mem_caps`` controller capabilities for the handling of memory operations. h](j)}(h ``mem_caps``h]h)}(hj!h]hmem_caps}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj!ubj)}(hhh]h)}(h>controller capabilities for the handling of memory operations.h]h>controller capabilities for the handling of memory operations.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hMhj!ubah}(h]h ]h"]h$]h&]uh1jhj!ubeh}(h]h ]h"]h$]h&]uh1jhj!hMhjyubj)}(h``dtr_caps`` true if controller has dtr(single/dual transfer rate) capability. QSPI based controller should fill this based on controller's capability. h](j)}(h ``dtr_caps``h]h)}(hj"h]hdtr_caps}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubj)}(hhh]h)}(htrue if controller has dtr(single/dual transfer rate) capability. QSPI based controller should fill this based on controller's capability.h]htrue if controller has dtr(single/dual transfer rate) capability. QSPI based controller should fill this based on controller’s capability.}(hj1"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj."ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj-"hMhjyubj)}(h``get_offload`` callback for controllers with offload support to get matching offload instance. Implementations should return -ENODEV if no match is found. h](j)}(h``get_offload``h]h)}(hjR"h]h get_offload}(hjT"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjP"ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjL"ubj)}(hhh]h)}(hcallback for controllers with offload support to get matching offload instance. Implementations should return -ENODEV if no match is found.h]hcallback for controllers with offload support to get matching offload instance. Implementations should return -ENODEV if no match is found.}(hjk"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjh"ubah}(h]h ]h"]h$]h&]uh1jhjL"ubeh}(h]h ]h"]h$]h&]uh1jhjg"hMhjyubj)}(hJ``put_offload`` release the offload instance acquired by **get_offload**. h](j)}(h``put_offload``h]h)}(hj"h]h put_offload}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubj)}(hhh]h)}(h9release the offload instance acquired by **get_offload**.h](h)release the offload instance acquired by }(hj"hhhNhNubj)}(h**get_offload**h]h get_offload}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj"ubh.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj"hMhj"ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj"hMhjyubj)}(h``cs_gpiods`` Array of GPIO descriptors to use as chip select lines; one per CS number. Any individual value may be NULL for CS lines that are not GPIOs (driven by the SPI controller itself). h](j)}(h ``cs_gpiods``h]h)}(hj"h]h cs_gpiods}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubj)}(hhh]h)}(hArray of GPIO descriptors to use as chip select lines; one per CS number. Any individual value may be NULL for CS lines that are not GPIOs (driven by the SPI controller itself).h]hArray of GPIO descriptors to use as chip select lines; one per CS number. Any individual value may be NULL for CS lines that are not GPIOs (driven by the SPI controller itself).}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj"ubah}(h]h ]h"]h$]h&]uh1jhj"ubeh}(h]h ]h"]h$]h&]uh1jhj"hMhjyubj)}(h``use_gpio_descriptors`` Turns on the code in the SPI core to parse and grab GPIO descriptors. This will fill in **cs_gpiods** and SPI devices will have the cs_gpiod assigned if a GPIO line is found for the chipselect. h](j)}(h``use_gpio_descriptors``h]h)}(hj#h]huse_gpio_descriptors}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM"hj #ubj)}(hhh]h)}(hTurns on the code in the SPI core to parse and grab GPIO descriptors. This will fill in **cs_gpiods** and SPI devices will have the cs_gpiod assigned if a GPIO line is found for the chipselect.h](hXTurns on the code in the SPI core to parse and grab GPIO descriptors. This will fill in }(hj*#hhhNhNubj)}(h **cs_gpiods**h]h cs_gpiods}(hj2#hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*#ubh\ and SPI devices will have the cs_gpiod assigned if a GPIO line is found for the chipselect.}(hj*#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj'#ubah}(h]h ]h"]h$]h&]uh1jhj #ubeh}(h]h ]h"]h$]h&]uh1jhj&#hM"hjyubj)}(h``unused_native_cs`` When cs_gpiods is used, spi_register_controller() will fill in this field with the first unused native CS, to be used by SPI controller drivers that need to drive a native CS when using GPIO CS. h](j)}(h``unused_native_cs``h]h)}(hj]#h]hunused_native_cs}(hj_#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[#ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM%hjW#ubj)}(hhh]h)}(hWhen cs_gpiods is used, spi_register_controller() will fill in this field with the first unused native CS, to be used by SPI controller drivers that need to drive a native CS when using GPIO CS.h]hWhen cs_gpiods is used, spi_register_controller() will fill in this field with the first unused native CS, to be used by SPI controller drivers that need to drive a native CS when using GPIO CS.}(hjv#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM#hjs#ubah}(h]h ]h"]h$]h&]uh1jhjW#ubeh}(h]h ]h"]h$]h&]uh1jhjr#hM%hjyubj)}(h``max_native_cs`` When cs_gpiods is used, and this field is filled in, spi_register_controller() will validate all native CS (including the unused native CS) against this value. h](j)}(h``max_native_cs``h]h)}(hj#h]h max_native_cs}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM(hj#ubj)}(hhh]h)}(hWhen cs_gpiods is used, and this field is filled in, spi_register_controller() will validate all native CS (including the unused native CS) against this value.h]hWhen cs_gpiods is used, and this field is filled in, spi_register_controller() will validate all native CS (including the unused native CS) against this value.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM&hj#ubah}(h]h ]h"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]uh1jhj#hM(hjyubj)}(h6``pcpu_statistics`` statistics for the spi_controller h](j)}(h``pcpu_statistics``h]h)}(hj#h]hpcpu_statistics}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM)hj#ubj)}(hhh]h)}(h!statistics for the spi_controllerh]h!statistics for the spi_controller}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hM)hj#ubah}(h]h ]h"]h$]h&]uh1jhj#ubeh}(h]h ]h"]h$]h&]uh1jhj#hM)hjyubj)}(h ``dma_tx`` DMA transmit channel h](j)}(h ``dma_tx``h]h)}(hj $h]hdma_tx}(hj $hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM*hj$ubj)}(hhh]h)}(hDMA transmit channelh]hDMA transmit channel}(hj#$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hM*hj $ubah}(h]h ]h"]h$]h&]uh1jhj$ubeh}(h]h ]h"]h$]h&]uh1jhj$hM*hjyubj)}(h``dma_rx`` DMA receive channel h](j)}(h ``dma_rx``h]h)}(hjC$h]hdma_rx}(hjE$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjA$ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM+hj=$ubj)}(hhh]h)}(hDMA receive channelh]hDMA receive channel}(hj\$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjX$hM+hjY$ubah}(h]h ]h"]h$]h&]uh1jhj=$ubeh}(h]h ]h"]h$]h&]uh1jhjX$hM+hjyubj)}(h:``dummy_rx`` dummy receive buffer for full-duplex devices h](j)}(h ``dummy_rx``h]h)}(hj|$h]hdummy_rx}(hj~$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjz$ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM,hjv$ubj)}(hhh]h)}(h,dummy receive buffer for full-duplex devicesh]h,dummy receive buffer for full-duplex devices}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hM,hj$ubah}(h]h ]h"]h$]h&]uh1jhjv$ubeh}(h]h ]h"]h$]h&]uh1jhj$hM,hjyubj)}(h;``dummy_tx`` dummy transmit buffer for full-duplex devices h](j)}(h ``dummy_tx``h]h)}(hj$h]hdummy_tx}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM-hj$ubj)}(hhh]h)}(h-dummy transmit buffer for full-duplex devicesh]h-dummy transmit buffer for full-duplex devices}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$hM-hj$ubah}(h]h ]h"]h$]h&]uh1jhj$ubeh}(h]h ]h"]h$]h&]uh1jhj$hM-hjyubj)}(h``fw_translate_cs`` If the boot firmware uses different numbering scheme what Linux expects, this optional hook can be used to translate between the two. h](j)}(h``fw_translate_cs``h]h)}(hj$h]hfw_translate_cs}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM0hj$ubj)}(hhh]h)}(hIf the boot firmware uses different numbering scheme what Linux expects, this optional hook can be used to translate between the two.h]hIf the boot firmware uses different numbering scheme what Linux expects, this optional hook can be used to translate between the two.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM.hj%ubah}(h]h ]h"]h$]h&]uh1jhj$ubeh}(h]h ]h"]h$]h&]uh1jhj%hM0hjyubj)}(hXp``ptp_sts_supported`` If the driver sets this to true, it must provide a time snapshot in **spi_transfer->ptp_sts** as close as possible to the moment in time when **spi_transfer->ptp_sts_word_pre** and **spi_transfer->ptp_sts_word_post** were transmitted. If the driver does not set this, the SPI core takes the snapshot as close to the driver hand-over as possible. h](j)}(h``ptp_sts_supported``h]h)}(hj(%h]hptp_sts_supported}(hj*%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&%ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM6hj"%ubj)}(hhh]h)}(hXYIf the driver sets this to true, it must provide a time snapshot in **spi_transfer->ptp_sts** as close as possible to the moment in time when **spi_transfer->ptp_sts_word_pre** and **spi_transfer->ptp_sts_word_post** were transmitted. If the driver does not set this, the SPI core takes the snapshot as close to the driver hand-over as possible.h](hDIf the driver sets this to true, it must provide a time snapshot in }(hjA%hhhNhNubj)}(h**spi_transfer->ptp_sts**h]hspi_transfer->ptp_sts}(hjI%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjA%ubh1 as close as possible to the moment in time when }(hjA%hhhNhNubj)}(h"**spi_transfer->ptp_sts_word_pre**h]hspi_transfer->ptp_sts_word_pre}(hj[%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjA%ubh and }(hjA%hhhNhNubj)}(h#**spi_transfer->ptp_sts_word_post**h]hspi_transfer->ptp_sts_word_post}(hjm%hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjA%ubh were transmitted. If the driver does not set this, the SPI core takes the snapshot as close to the driver hand-over as possible.}(hjA%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM1hj>%ubah}(h]h ]h"]h$]h&]uh1jhj"%ubeh}(h]h ]h"]h$]h&]uh1jhj=%hM6hjyubj)}(hD``irq_flags`` Interrupt enable state during PTP system timestamping h](j)}(h ``irq_flags``h]h)}(hj%h]h irq_flags}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM7hj%ubj)}(hhh]h)}(h5Interrupt enable state during PTP system timestampingh]h5Interrupt enable state during PTP system timestamping}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hM7hj%ubah}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]uh1jhj%hM7hjyubj)}(hd``queue_empty`` signal green light for opportunistically skipping the queue for spi_sync transfers. h](j)}(h``queue_empty``h]h)}(hj%h]h queue_empty}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM9hj%ubj)}(hhh]h)}(hSsignal green light for opportunistically skipping the queue for spi_sync transfers.h]hSsignal green light for opportunistically skipping the queue for spi_sync transfers.}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM8hj%ubah}(h]h ]h"]h$]h&]uh1jhj%ubeh}(h]h ]h"]h$]h&]uh1jhj%hM9hjyubj)}(h2``must_async`` disable all fast paths in the core h](j)}(h``must_async``h]h)}(hj &h]h must_async}(hj &hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj &ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM:hj&ubj)}(hhh]h)}(h"disable all fast paths in the coreh]h"disable all fast paths in the core}(hj$&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj &hM:hj!&ubah}(h]h ]h"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]uh1jhj &hM:hjyubj)}(h``defer_optimize_message`` set to true if controller cannot pre-optimize messages and needs to defer the optimization step until the message is actually being transferred h](j)}(h``defer_optimize_message``h]h)}(hjD&h]hdefer_optimize_message}(hjF&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjB&ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM=hj>&ubj)}(hhh]h)}(hset to true if controller cannot pre-optimize messages and needs to defer the optimization step until the message is actually being transferredh]hset to true if controller cannot pre-optimize messages and needs to defer the optimization step until the message is actually being transferred}(hj]&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM;hjZ&ubah}(h]h ]h"]h$]h&]uh1jhj>&ubeh}(h]h ]h"]h$]h&]uh1jhjY&hM=hjyubj)}(h``userspace_clients`` list of SPI devices instantiated from userspace via the sysfs new_device interface; protected by **add_lock** h](j)}(h``userspace_clients``h]h)}(hj~&h]huserspace_clients}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|&ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM?hjx&ubj)}(hhh]h)}(hmlist of SPI devices instantiated from userspace via the sysfs new_device interface; protected by **add_lock**h](halist of SPI devices instantiated from userspace via the sysfs new_device interface; protected by }(hj&hhhNhNubj)}(h **add_lock**h]hadd_lock}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM>hj&ubah}(h]h ]h"]h$]h&]uh1jhjx&ubeh}(h]h ]h"]h$]h&]uh1jhj&hM?hjyubj)}(h``userspace_registered`` true once the new_device/delete_device sysfs group has been added by spi_register_controller(); used by spi_unregister_controller() to know whether to remove ith](j)}(h``userspace_registered``h]h)}(hj&h]huserspace_registered}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj&ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMAhj&ubj)}(hhh]h)}(htrue once the new_device/delete_device sysfs group has been added by spi_register_controller(); used by spi_unregister_controller() to know whether to remove ith]htrue once the new_device/delete_device sysfs group has been added by spi_register_controller(); used by spi_unregister_controller() to know whether to remove it}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM@hj&ubah}(h]h ]h"]h$]h&]uh1jhj&ubeh}(h]h ]h"]h$]h&]uh1jhj&hMAhjyubeh}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubh)}(h**Description**h]j)}(hj 'h]h Description}(hj 'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMEhhhhubj)}(hX- return 0 if the transfer is finished, - return 1 if the transfer is still in progress. When the driver is finished with this transfer it must call spi_finalize_current_transfer() so the subsystem can issue the next transfer. If the transfer fails, the driver must set the flag SPI_TRANS_FAIL_IO to spi_transfer->error first, before calling spi_finalize_current_transfer(). h]h bullet_list)}(hhh](h list_item)}(h%return 0 if the transfer is finished,h]h)}(hj,'h]h%return 0 if the transfer is finished,}(hj.'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*'ubah}(h]h ]h"]h$]h&]uh1j('hj%'ubj)')}(hXMreturn 1 if the transfer is still in progress. When the driver is finished with this transfer it must call spi_finalize_current_transfer() so the subsystem can issue the next transfer. If the transfer fails, the driver must set the flag SPI_TRANS_FAIL_IO to spi_transfer->error first, before calling spi_finalize_current_transfer(). h]h)}(hXLreturn 1 if the transfer is still in progress. When the driver is finished with this transfer it must call spi_finalize_current_transfer() so the subsystem can issue the next transfer. If the transfer fails, the driver must set the flag SPI_TRANS_FAIL_IO to spi_transfer->error first, before calling spi_finalize_current_transfer().h]hXLreturn 1 if the transfer is still in progress. When the driver is finished with this transfer it must call spi_finalize_current_transfer() so the subsystem can issue the next transfer. If the transfer fails, the driver must set the flag SPI_TRANS_FAIL_IO to spi_transfer->error first, before calling spi_finalize_current_transfer().}(hjF'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjB'ubah}(h]h ]h"]h$]h&]uh1j('hj%'ubeh}(h]h ]h"]h$]h&]bullet-uh1j#'hj;'hMhj'ubah}(h]h ]h"]h$]h&]uh1jhj;'hMhhhhubh)}(hX(Each SPI controller can communicate with one or more **spi_device** children. These make a small bus, sharing MOSI, MISO and SCK signals but not chip select signals. Each device may be configured to use a different clock rate, since those shared signals are ignored unless the chip is selected.h](h5Each SPI controller can communicate with one or more }(hji'hhhNhNubj)}(h**spi_device**h]h spi_device}(hjq'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhji'ubh children. These make a small bus, sharing MOSI, MISO and SCK signals but not chip select signals. Each device may be configured to use a different clock rate, since those shared signals are ignored unless the chip is selected.}(hji'hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hhhhubh)}(hXThe driver for an SPI controller manages access to those devices through a queue of spi_message transactions, copying data between CPU memory and an SPI target device. For each such message it queues, it calls the message's completion function when the transaction completes.h]hXThe driver for an SPI controller manages access to those devices through a queue of spi_message transactions, copying data between CPU memory and an SPI target device. For each such message it queues, it calls the message’s completion function when the transaction completes.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(h**Note**h]j)}(hj'h]hNote}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj'ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubj)}(hhh]j)}(htransfer_one and transfer_one_message are mutually exclusive; when both are set, the generic subsystem does not call your transfer_one callback. h](j)}(h2transfer_one and transfer_one_message are mutuallyh]h2transfer_one and transfer_one_message are mutually}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj'ubj)}(hhh]h)}(h]exclusive; when both are set, the generic subsystem does not call your transfer_one callback.h]h]exclusive; when both are set, the generic subsystem does not call your transfer_one callback.}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj'ubah}(h]h ]h"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]uh1jhj'hMhj'ubah}(h]h ]h"]h$]h&]uh1jhhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_res (C struct) c.spi_reshNtauh1jhhhhhjhNubj)}(hhh](j)}(hspi_resh]j)}(hstruct spi_resh](j)}(hjh]hstruct}(hj(hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj(hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj(hhhj(hMubj$)}(hspi_resh]j*)}(hj'h]hspi_res}(hj$(hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj (ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj(hhhj(hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj'hhhj(hMubah}(h]j'ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj(hMhj'hhubjX)}(hhh]h)}(h!SPI resource management structureh]h!SPI resource management structure}(hjF(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjC(hhubah}(h]h ]h"]h$]h&]uh1jWhj'hhhj(hMubeh}(h]h ](jstructeh"]h$]h&]jxjjyj^(jzj^(j{j|j}uh1jhhhhhjhNubj)}(hX7**Definition**:: struct spi_res { struct list_head entry; spi_res_release_t release; unsigned long long data[]; }; **Members** ``entry`` list entry ``release`` release code called prior to freeing this resource ``data`` extra data allocated for the specific use-caseh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjf(ubh:}(hjf(hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjb(ubj)}(hystruct spi_res { struct list_head entry; spi_res_release_t release; unsigned long long data[]; };h]hystruct spi_res { struct list_head entry; spi_res_release_t release; unsigned long long data[]; };}hj(sbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjb(ubh)}(h **Members**h]j)}(hj(h]hMembers}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj(ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjb(ubj)}(hhh](j)}(h``entry`` list entry h](j)}(h ``entry``h]h)}(hj(h]hentry}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj(ubj)}(hhh]h)}(h list entryh]h list entry}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hMhj(ubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhj(hMhj(ubj)}(h?``release`` release code called prior to freeing this resource h](j)}(h ``release``h]h)}(hj(h]hrelease}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj(ubj)}(hhh]h)}(h2release code called prior to freeing this resourceh]h2release code called prior to freeing this resource}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hMhj)ubah}(h]h ]h"]h$]h&]uh1jhj(ubeh}(h]h ]h"]h$]h&]uh1jhj)hMhj(ubj)}(h7``data`` extra data allocated for the specific use-caseh](j)}(h``data``h]h)}(hj%)h]hdata}(hj')hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#)ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj)ubj)}(hhh]h)}(h.extra data allocated for the specific use-caseh]h.extra data allocated for the specific use-case}(hj>)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj;)ubah}(h]h ]h"]h$]h&]uh1jhj)ubeh}(h]h ]h"]h$]h&]uh1jhj:)hMhj(ubeh}(h]h ]h"]h$]h&]uh1jhjb(ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubh)}(h**Description**h]j)}(hjh)h]h Description}(hjj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjf)ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hgThis is based on ideas from devres, but focused on life-cycle management during spi_message processing.h]hgThis is based on ideas from devres, but focused on life-cycle management during spi_message processing.}(hj~)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_transfer (C struct)c.spi_transferhNtauh1jhhhhhjhNubj)}(hhh](j)}(h spi_transferh]j)}(hstruct spi_transferh](j)}(hjh]hstruct}(hj)hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj)hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hj)hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj)hhhj)hMubj$)}(h spi_transferh]j*)}(hj)h]h spi_transfer}(hj)hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj)ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj)hhhj)hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj)hhhj)hMubah}(h]j)ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj)hMhj)hhubjX)}(hhh]h)}(ha read/write buffer pairh]ha read/write buffer pair}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj)hhubah}(h]h ]h"]h$]h&]uh1jWhj)hhhj)hMubeh}(h]h ](jstructeh"]h$]h&]jxjjyj*jzj*j{j|j}uh1jhhhhhjhNubj)}(hX**Definition**:: struct spi_transfer { const void *tx_buf; void *rx_buf; unsigned len; #define SPI_TRANS_FAIL_NO_START BIT(0); #define SPI_TRANS_FAIL_IO BIT(1); u16 error; bool tx_sg_mapped; bool rx_sg_mapped; struct sg_table tx_sg; struct sg_table rx_sg; dma_addr_t tx_dma; dma_addr_t rx_dma; unsigned dummy_data:1; unsigned cs_off:1; unsigned cs_change:1; unsigned tx_nbits:4; unsigned rx_nbits:4; #define SPI_MULTI_LANE_MODE_SINGLE 0 ; #define SPI_MULTI_LANE_MODE_STRIPE 1 ; #define SPI_MULTI_LANE_MODE_MIRROR 2 ; unsigned multi_lane_mode: 2; unsigned timestamped:1; bool dtr_mode; #define SPI_NBITS_SINGLE 0x01 ; #define SPI_NBITS_DUAL 0x02 ; #define SPI_NBITS_QUAD 0x04 ; #define SPI_NBITS_OCTAL 0x08 ; u8 bits_per_word; struct spi_delay delay; struct spi_delay cs_change_delay; struct spi_delay word_delay; u32 speed_hz; u32 effective_speed_hz; unsigned int offload_flags; unsigned int ptp_sts_word_pre; unsigned int ptp_sts_word_post; struct ptp_system_timestamp *ptp_sts; struct list_head transfer_list; }; **Members** ``tx_buf`` data to be written (DMA-safe memory), or NULL ``rx_buf`` data to be read (DMA-safe memory), or NULL ``len`` size of rx and tx buffers (in bytes) ``error`` Error status logged by SPI controller driver. ``tx_sg_mapped`` If true, the **tx_sg** is mapped for DMA ``rx_sg_mapped`` If true, the **rx_sg** is mapped for DMA ``tx_sg`` Scatterlist for transmit, currently not for client use ``rx_sg`` Scatterlist for receive, currently not for client use ``tx_dma`` DMA address of tx_buf, currently not for client use ``rx_dma`` DMA address of rx_buf, currently not for client use ``dummy_data`` indicates transfer is dummy bytes transfer. ``cs_off`` performs the transfer with chipselect off. ``cs_change`` affects chipselect after this transfer completes ``tx_nbits`` number of bits used for writing. If 0 the default (SPI_NBITS_SINGLE) is used. ``rx_nbits`` number of bits used for reading. If 0 the default (SPI_NBITS_SINGLE) is used. ``multi_lane_mode`` How to serialize data on multiple lanes. One of the SPI_MULTI_LANE_MODE_* values. ``timestamped`` true if the transfer has been timestamped ``dtr_mode`` true if supports double transfer rate. ``bits_per_word`` select a bits_per_word other than the device default for this transfer. If 0 the default (from **spi_device**) is used. ``delay`` delay to be introduced after this transfer before (optionally) changing the chipselect status, then starting the next transfer or completing this **spi_message**. ``cs_change_delay`` delay between cs deassert and assert when **cs_change** is set and **spi_transfer** is not the last in **spi_message** ``word_delay`` inter word delay to be introduced after each word size (set by bits_per_word) transmission. ``speed_hz`` Select a speed other than the device default for this transfer. If 0 the default (from **spi_device**) is used. ``effective_speed_hz`` the effective SCK-speed that was used to transfer this transfer. Set to 0 if the SPI bus driver does not support it. ``offload_flags`` Flags that are only applicable to specialized SPI offload transfers. See ``SPI_OFFLOAD_XFER_*`` in spi-offload.h. ``ptp_sts_word_pre`` The word (subject to bits_per_word semantics) offset within **tx_buf** for which the SPI device is requesting that the time snapshot for this transfer begins. Upon completing the SPI transfer, this value may have changed compared to what was requested, depending on the available snapshotting resolution (DMA transfer, **ptp_sts_supported** is false, etc). ``ptp_sts_word_post`` See **ptp_sts_word_pre**. The two can be equal (meaning that a single byte should be snapshotted). If the core takes care of the timestamp (if **ptp_sts_supported** is false for this controller), it will set **ptp_sts_word_pre** to 0, and **ptp_sts_word_post** to the length of the transfer. This is done purposefully (instead of setting to spi_transfer->len - 1) to denote that a transfer-level snapshot taken from within the driver may still be of higher quality. ``ptp_sts`` Pointer to a memory location held by the SPI target device where a PTP system timestamp structure may lie. If drivers use PIO or their hardware has some sort of assist for retrieving exact transfer timing, they can (and should) assert **ptp_sts_supported** and populate this structure using the ptp_read_system_*ts helper functions. The timestamp must represent the time at which the SPI target device has processed the word, i.e. the "pre" timestamp should be taken before transmitting the "pre" word, and the "post" timestamp after receiving transmit confirmation from the controller for the "post" word. ``transfer_list`` transfers are sequenced through **spi_message.transfers**h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj *hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj*ubh:}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*ubj)}(hXstruct spi_transfer { const void *tx_buf; void *rx_buf; unsigned len; #define SPI_TRANS_FAIL_NO_START BIT(0); #define SPI_TRANS_FAIL_IO BIT(1); u16 error; bool tx_sg_mapped; bool rx_sg_mapped; struct sg_table tx_sg; struct sg_table rx_sg; dma_addr_t tx_dma; dma_addr_t rx_dma; unsigned dummy_data:1; unsigned cs_off:1; unsigned cs_change:1; unsigned tx_nbits:4; unsigned rx_nbits:4; #define SPI_MULTI_LANE_MODE_SINGLE 0 ; #define SPI_MULTI_LANE_MODE_STRIPE 1 ; #define SPI_MULTI_LANE_MODE_MIRROR 2 ; unsigned multi_lane_mode: 2; unsigned timestamped:1; bool dtr_mode; #define SPI_NBITS_SINGLE 0x01 ; #define SPI_NBITS_DUAL 0x02 ; #define SPI_NBITS_QUAD 0x04 ; #define SPI_NBITS_OCTAL 0x08 ; u8 bits_per_word; struct spi_delay delay; struct spi_delay cs_change_delay; struct spi_delay word_delay; u32 speed_hz; u32 effective_speed_hz; unsigned int offload_flags; unsigned int ptp_sts_word_pre; unsigned int ptp_sts_word_post; struct ptp_system_timestamp *ptp_sts; struct list_head transfer_list; };h]hXstruct spi_transfer { const void *tx_buf; void *rx_buf; unsigned len; #define SPI_TRANS_FAIL_NO_START BIT(0); #define SPI_TRANS_FAIL_IO BIT(1); u16 error; bool tx_sg_mapped; bool rx_sg_mapped; struct sg_table tx_sg; struct sg_table rx_sg; dma_addr_t tx_dma; dma_addr_t rx_dma; unsigned dummy_data:1; unsigned cs_off:1; unsigned cs_change:1; unsigned tx_nbits:4; unsigned rx_nbits:4; #define SPI_MULTI_LANE_MODE_SINGLE 0 ; #define SPI_MULTI_LANE_MODE_STRIPE 1 ; #define SPI_MULTI_LANE_MODE_MIRROR 2 ; unsigned multi_lane_mode: 2; unsigned timestamped:1; bool dtr_mode; #define SPI_NBITS_SINGLE 0x01 ; #define SPI_NBITS_DUAL 0x02 ; #define SPI_NBITS_QUAD 0x04 ; #define SPI_NBITS_OCTAL 0x08 ; u8 bits_per_word; struct spi_delay delay; struct spi_delay cs_change_delay; struct spi_delay word_delay; u32 speed_hz; u32 effective_speed_hz; unsigned int offload_flags; unsigned int ptp_sts_word_pre; unsigned int ptp_sts_word_post; struct ptp_system_timestamp *ptp_sts; struct list_head transfer_list; };}hj%*sbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*ubh)}(h **Members**h]j)}(hj6*h]hMembers}(hj8*hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4*ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*ubj)}(hhh](j)}(h9``tx_buf`` data to be written (DMA-safe memory), or NULL h](j)}(h ``tx_buf``h]h)}(hjU*h]htx_buf}(hjW*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjS*ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjO*ubj)}(hhh]h)}(h-data to be written (DMA-safe memory), or NULLh]h-data to be written (DMA-safe memory), or NULL}(hjn*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjj*hMhjk*ubah}(h]h ]h"]h$]h&]uh1jhjO*ubeh}(h]h ]h"]h$]h&]uh1jhjj*hMhjL*ubj)}(h6``rx_buf`` data to be read (DMA-safe memory), or NULL h](j)}(h ``rx_buf``h]h)}(hj*h]hrx_buf}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*ubj)}(hhh]h)}(h*data to be read (DMA-safe memory), or NULLh]h*data to be read (DMA-safe memory), or NULL}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hMhj*ubah}(h]h ]h"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]uh1jhj*hMhjL*ubj)}(h-``len`` size of rx and tx buffers (in bytes) h](j)}(h``len``h]h)}(hj*h]hlen}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*ubj)}(hhh]h)}(h$size of rx and tx buffers (in bytes)h]h$size of rx and tx buffers (in bytes)}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*hMhj*ubah}(h]h ]h"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]uh1jhj*hMhjL*ubj)}(h8``error`` Error status logged by SPI controller driver. h](j)}(h ``error``h]h)}(hj+h]herror}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM+hj*ubj)}(hhh]h)}(h-Error status logged by SPI controller driver.h]h-Error status logged by SPI controller driver.}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hM+hj+ubah}(h]h ]h"]h$]h&]uh1jhj*ubeh}(h]h ]h"]h$]h&]uh1jhj+hM+hjL*ubj)}(h:``tx_sg_mapped`` If true, the **tx_sg** is mapped for DMA h](j)}(h``tx_sg_mapped``h]h)}(hj9+h]h tx_sg_mapped}(hj;+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7+ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj3+ubj)}(hhh]h)}(h(If true, the **tx_sg** is mapped for DMAh](h If true, the }(hjR+hhhNhNubj)}(h **tx_sg**h]htx_sg}(hjZ+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjR+ubh is mapped for DMA}(hjR+hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjN+hM hjO+ubah}(h]h ]h"]h$]h&]uh1jhj3+ubeh}(h]h ]h"]h$]h&]uh1jhjN+hM hjL*ubj)}(h:``rx_sg_mapped`` If true, the **rx_sg** is mapped for DMA h](j)}(h``rx_sg_mapped``h]h)}(hj+h]h rx_sg_mapped}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj~+ubj)}(hhh]h)}(h(If true, the **rx_sg** is mapped for DMAh](h If true, the }(hj+hhhNhNubj)}(h **rx_sg**h]hrx_sg}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj+ubh is mapped for DMA}(hj+hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj+hM hj+ubah}(h]h ]h"]h$]h&]uh1jhj~+ubeh}(h]h ]h"]h$]h&]uh1jhj+hM hjL*ubj)}(hA``tx_sg`` Scatterlist for transmit, currently not for client use h](j)}(h ``tx_sg``h]h)}(hj+h]htx_sg}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj+ubj)}(hhh]h)}(h6Scatterlist for transmit, currently not for client useh]h6Scatterlist for transmit, currently not for client use}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj+hMhj+ubah}(h]h ]h"]h$]h&]uh1jhj+ubeh}(h]h ]h"]h$]h&]uh1jhj+hMhjL*ubj)}(h@``rx_sg`` Scatterlist for receive, currently not for client use h](j)}(h ``rx_sg``h]h)}(hj,h]hrx_sg}(hj ,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj,ubj)}(hhh]h)}(h5Scatterlist for receive, currently not for client useh]h5Scatterlist for receive, currently not for client use}(hj!,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jhj,ubeh}(h]h ]h"]h$]h&]uh1jhj,hMhjL*ubj)}(h?``tx_dma`` DMA address of tx_buf, currently not for client use h](j)}(h ``tx_dma``h]h)}(hjA,h]htx_dma}(hjC,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj?,ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj;,ubj)}(hhh]h)}(h3DMA address of tx_buf, currently not for client useh]h3DMA address of tx_buf, currently not for client use}(hjZ,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjV,hMhjW,ubah}(h]h ]h"]h$]h&]uh1jhj;,ubeh}(h]h ]h"]h$]h&]uh1jhjV,hMhjL*ubj)}(h?``rx_dma`` DMA address of rx_buf, currently not for client use h](j)}(h ``rx_dma``h]h)}(hjz,h]hrx_dma}(hj|,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjx,ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt,ubj)}(hhh]h)}(h3DMA address of rx_buf, currently not for client useh]h3DMA address of rx_buf, currently not for client use}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jhjt,ubeh}(h]h ]h"]h$]h&]uh1jhj,hMhjL*ubj)}(h;``dummy_data`` indicates transfer is dummy bytes transfer. h](j)}(h``dummy_data``h]h)}(hj,h]h dummy_data}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj,ubj)}(hhh]h)}(h+indicates transfer is dummy bytes transfer.h]h+indicates transfer is dummy bytes transfer.}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hMhj,ubah}(h]h ]h"]h$]h&]uh1jhj,ubeh}(h]h ]h"]h$]h&]uh1jhj,hMhjL*ubj)}(h6``cs_off`` performs the transfer with chipselect off. h](j)}(h ``cs_off``h]h)}(hj,h]hcs_off}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj,ubj)}(hhh]h)}(h*performs the transfer with chipselect off.h]h*performs the transfer with chipselect off.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-hMhj-ubah}(h]h ]h"]h$]h&]uh1jhj,ubeh}(h]h ]h"]h$]h&]uh1jhj-hMhjL*ubj)}(h?``cs_change`` affects chipselect after this transfer completes h](j)}(h ``cs_change``h]h)}(hj%-h]h cs_change}(hj'-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#-ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-ubj)}(hhh]h)}(h0affects chipselect after this transfer completesh]h0affects chipselect after this transfer completes}(hj>-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj:-hMhj;-ubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]uh1jhj:-hMhjL*ubj)}(h[``tx_nbits`` number of bits used for writing. If 0 the default (SPI_NBITS_SINGLE) is used. h](j)}(h ``tx_nbits``h]h)}(hj^-h]htx_nbits}(hj`-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\-ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjX-ubj)}(hhh]h)}(hMnumber of bits used for writing. If 0 the default (SPI_NBITS_SINGLE) is used.h]hMnumber of bits used for writing. If 0 the default (SPI_NBITS_SINGLE) is used.}(hjw-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt-ubah}(h]h ]h"]h$]h&]uh1jhjX-ubeh}(h]h ]h"]h$]h&]uh1jhjs-hMhjL*ubj)}(h[``rx_nbits`` number of bits used for reading. If 0 the default (SPI_NBITS_SINGLE) is used. h](j)}(h ``rx_nbits``h]h)}(hj-h]hrx_nbits}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-ubj)}(hhh]h)}(hMnumber of bits used for reading. If 0 the default (SPI_NBITS_SINGLE) is used.h]hMnumber of bits used for reading. If 0 the default (SPI_NBITS_SINGLE) is used.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-ubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]uh1jhj-hMhjL*ubj)}(hf``multi_lane_mode`` How to serialize data on multiple lanes. One of the SPI_MULTI_LANE_MODE_* values. h](j)}(h``multi_lane_mode``h]h)}(hj-h]hmulti_lane_mode}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-ubj)}(hhh]h)}(hQHow to serialize data on multiple lanes. One of the SPI_MULTI_LANE_MODE_* values.h]hQHow to serialize data on multiple lanes. One of the SPI_MULTI_LANE_MODE_* values.}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-ubah}(h]h ]h"]h$]h&]uh1jhj-ubeh}(h]h ]h"]h$]h&]uh1jhj-hMhjL*ubj)}(h:``timestamped`` true if the transfer has been timestamped h](j)}(h``timestamped``h]h)}(hj .h]h timestamped}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj .ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM*hj.ubj)}(hhh]h)}(h)true if the transfer has been timestampedh]h)true if the transfer has been timestamped}(hj%.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!.hM*hj".ubah}(h]h ]h"]h$]h&]uh1jhj.ubeh}(h]h ]h"]h$]h&]uh1jhj!.hM*hjL*ubj)}(h4``dtr_mode`` true if supports double transfer rate. h](j)}(h ``dtr_mode``h]h)}(hjE.h]hdtr_mode}(hjG.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjC.ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM)hj?.ubj)}(hhh]h)}(h&true if supports double transfer rate.h]h&true if supports double transfer rate.}(hj^.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjZ.hM)hj[.ubah}(h]h ]h"]h$]h&]uh1jhj?.ubeh}(h]h ]h"]h$]h&]uh1jhjZ.hM)hjL*ubj)}(h``bits_per_word`` select a bits_per_word other than the device default for this transfer. If 0 the default (from **spi_device**) is used. h](j)}(h``bits_per_word``h]h)}(hj~.h]h bits_per_word}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|.ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjx.ubj)}(hhh]h)}(hwselect a bits_per_word other than the device default for this transfer. If 0 the default (from **spi_device**) is used.h](h_select a bits_per_word other than the device default for this transfer. If 0 the default (from }(hj.hhhNhNubj)}(h**spi_device**h]h spi_device}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubh ) is used.}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj.ubah}(h]h ]h"]h$]h&]uh1jhjx.ubeh}(h]h ]h"]h$]h&]uh1jhj.hMhjL*ubj)}(h``delay`` delay to be introduced after this transfer before (optionally) changing the chipselect status, then starting the next transfer or completing this **spi_message**. h](j)}(h ``delay``h]h)}(hj.h]hdelay}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj.ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj.ubj)}(hhh]h)}(hdelay to be introduced after this transfer before (optionally) changing the chipselect status, then starting the next transfer or completing this **spi_message**.h](hdelay to be introduced after this transfer before (optionally) changing the chipselect status, then starting the next transfer or completing this }(hj.hhhNhNubj)}(h**spi_message**h]h spi_message}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubh.}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj.ubah}(h]h ]h"]h$]h&]uh1jhj.ubeh}(h]h ]h"]h$]h&]uh1jhj.hMhjL*ubj)}(h``cs_change_delay`` delay between cs deassert and assert when **cs_change** is set and **spi_transfer** is not the last in **spi_message** h](j)}(h``cs_change_delay``h]h)}(hj/h]hcs_change_delay}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj/ubj)}(hhh]h)}(hvdelay between cs deassert and assert when **cs_change** is set and **spi_transfer** is not the last in **spi_message**h](h*delay between cs deassert and assert when }(hj//hhhNhNubj)}(h **cs_change**h]h cs_change}(hj7/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj//ubh is set and }(hj//hhhNhNubj)}(h**spi_transfer**h]h spi_transfer}(hjI/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj//ubh is not the last in }(hj//hhhNhNubj)}(h**spi_message**h]h spi_message}(hj[/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj//ubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj,/ubah}(h]h ]h"]h$]h&]uh1jhj/ubeh}(h]h ]h"]h$]h&]uh1jhj+/hMhjL*ubj)}(hk``word_delay`` inter word delay to be introduced after each word size (set by bits_per_word) transmission. h](j)}(h``word_delay``h]h)}(hj/h]h word_delay}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj|/ubj)}(hhh]h)}(h[inter word delay to be introduced after each word size (set by bits_per_word) transmission.h]h[inter word delay to be introduced after each word size (set by bits_per_word) transmission.}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj/ubah}(h]h ]h"]h$]h&]uh1jhj|/ubeh}(h]h ]h"]h$]h&]uh1jhj/hMhjL*ubj)}(h}``speed_hz`` Select a speed other than the device default for this transfer. If 0 the default (from **spi_device**) is used. h](j)}(h ``speed_hz``h]h)}(hj/h]hspeed_hz}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj/ubj)}(hhh]h)}(hoSelect a speed other than the device default for this transfer. If 0 the default (from **spi_device**) is used.h](hWSelect a speed other than the device default for this transfer. If 0 the default (from }(hj/hhhNhNubj)}(h**spi_device**h]h spi_device}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj/ubh ) is used.}(hj/hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj/ubah}(h]h ]h"]h$]h&]uh1jhj/ubeh}(h]h ]h"]h$]h&]uh1jhj/hMhjL*ubj)}(h``effective_speed_hz`` the effective SCK-speed that was used to transfer this transfer. Set to 0 if the SPI bus driver does not support it. h](j)}(h``effective_speed_hz``h]h)}(hj0h]heffective_speed_hz}(hj 0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj0ubj)}(hhh]h)}(htthe effective SCK-speed that was used to transfer this transfer. Set to 0 if the SPI bus driver does not support it.h]htthe effective SCK-speed that was used to transfer this transfer. Set to 0 if the SPI bus driver does not support it.}(hj!0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj0ubah}(h]h ]h"]h$]h&]uh1jhj0ubeh}(h]h ]h"]h$]h&]uh1jhj0hM hjL*ubj)}(h``offload_flags`` Flags that are only applicable to specialized SPI offload transfers. See ``SPI_OFFLOAD_XFER_*`` in spi-offload.h. h](j)}(h``offload_flags``h]h)}(hjB0h]h offload_flags}(hjD0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj@0ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj<0ubj)}(hhh]h)}(hqFlags that are only applicable to specialized SPI offload transfers. See ``SPI_OFFLOAD_XFER_*`` in spi-offload.h.h](hIFlags that are only applicable to specialized SPI offload transfers. See }(hj[0hhhNhNubh)}(h``SPI_OFFLOAD_XFER_*``h]hSPI_OFFLOAD_XFER_*}(hjc0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[0ubh in spi-offload.h.}(hj[0hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjX0ubah}(h]h ]h"]h$]h&]uh1jhj<0ubeh}(h]h ]h"]h$]h&]uh1jhjW0hMhjL*ubj)}(hXz``ptp_sts_word_pre`` The word (subject to bits_per_word semantics) offset within **tx_buf** for which the SPI device is requesting that the time snapshot for this transfer begins. Upon completing the SPI transfer, this value may have changed compared to what was requested, depending on the available snapshotting resolution (DMA transfer, **ptp_sts_supported** is false, etc). h](j)}(h``ptp_sts_word_pre``h]h)}(hj0h]hptp_sts_word_pre}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj0ubj)}(hhh]h)}(hXdThe word (subject to bits_per_word semantics) offset within **tx_buf** for which the SPI device is requesting that the time snapshot for this transfer begins. Upon completing the SPI transfer, this value may have changed compared to what was requested, depending on the available snapshotting resolution (DMA transfer, **ptp_sts_supported** is false, etc).h](hlen - 1) to denote that a transfer-level snapshot taken from within the driver may still be of higher quality. h](j)}(h``ptp_sts_word_post``h]h)}(hj0h]hptp_sts_word_post}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj0ubj)}(hhh]h)}(hXSee **ptp_sts_word_pre**. The two can be equal (meaning that a single byte should be snapshotted). If the core takes care of the timestamp (if **ptp_sts_supported** is false for this controller), it will set **ptp_sts_word_pre** to 0, and **ptp_sts_word_post** to the length of the transfer. This is done purposefully (instead of setting to spi_transfer->len - 1) to denote that a transfer-level snapshot taken from within the driver may still be of higher quality.h](hSee }(hj1hhhNhNubj)}(h**ptp_sts_word_pre**h]hptp_sts_word_pre}(hj 1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubhw. The two can be equal (meaning that a single byte should be snapshotted). If the core takes care of the timestamp (if }(hj1hhhNhNubj)}(h**ptp_sts_supported**h]hptp_sts_supported}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubh, is false for this controller), it will set }(hj1hhhNhNubj)}(h**ptp_sts_word_pre**h]hptp_sts_word_pre}(hj11hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubh to 0, and }(hj1hhhNhNubj)}(h**ptp_sts_word_post**h]hptp_sts_word_post}(hjC1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubh to the length of the transfer. This is done purposefully (instead of setting to spi_transfer->len - 1) to denote that a transfer-level snapshot taken from within the driver may still be of higher quality.}(hj1hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj1ubah}(h]h ]h"]h$]h&]uh1jhj0ubeh}(h]h ]h"]h$]h&]uh1jhj1hMhjL*ubj)}(hXk``ptp_sts`` Pointer to a memory location held by the SPI target device where a PTP system timestamp structure may lie. If drivers use PIO or their hardware has some sort of assist for retrieving exact transfer timing, they can (and should) assert **ptp_sts_supported** and populate this structure using the ptp_read_system_*ts helper functions. The timestamp must represent the time at which the SPI target device has processed the word, i.e. the "pre" timestamp should be taken before transmitting the "pre" word, and the "post" timestamp after receiving transmit confirmation from the controller for the "post" word. h](j)}(h ``ptp_sts``h]h)}(hjn1h]hptp_sts}(hjp1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjl1ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM(hjh1ubj)}(hhh]h)}(hX^Pointer to a memory location held by the SPI target device where a PTP system timestamp structure may lie. If drivers use PIO or their hardware has some sort of assist for retrieving exact transfer timing, they can (and should) assert **ptp_sts_supported** and populate this structure using the ptp_read_system_*ts helper functions. The timestamp must represent the time at which the SPI target device has processed the word, i.e. the "pre" timestamp should be taken before transmitting the "pre" word, and the "post" timestamp after receiving transmit confirmation from the controller for the "post" word.h](hPointer to a memory location held by the SPI target device where a PTP system timestamp structure may lie. If drivers use PIO or their hardware has some sort of assist for retrieving exact transfer timing, they can (and should) assert }(hj1hhhNhNubj)}(h**ptp_sts_supported**h]hptp_sts_supported}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubhXn and populate this structure using the ptp_read_system_*ts helper functions. The timestamp must represent the time at which the SPI target device has processed the word, i.e. the “pre” timestamp should be taken before transmitting the “pre” word, and the “post” timestamp after receiving transmit confirmation from the controller for the “post” word.}(hj1hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj1ubah}(h]h ]h"]h$]h&]uh1jhjh1ubeh}(h]h ]h"]h$]h&]uh1jhj1hM(hjL*ubj)}(hK``transfer_list`` transfers are sequenced through **spi_message.transfers**h](j)}(h``transfer_list``h]h)}(hj1h]h transfer_list}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj1ubj)}(hhh]h)}(h9transfers are sequenced through **spi_message.transfers**h](h transfers are sequenced through }(hj1hhhNhNubj)}(h**spi_message.transfers**h]hspi_message.transfers}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM hj1ubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1jhj1hM hjL*ubeh}(h]h ]h"]h$]h&]uh1jhj*ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubh)}(h**Description**h]j)}(hj 2h]h Description}(hj 2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj 2ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hX SPI transfers always write the same number of bytes as they read. Protocol drivers should always provide **rx_buf** and/or **tx_buf**. In some cases, they may also want to provide DMA addresses for the data being transferred; that may reduce overhead, when the underlying driver uses DMA.h](hiSPI transfers always write the same number of bytes as they read. Protocol drivers should always provide }(hj!2hhhNhNubj)}(h **rx_buf**h]hrx_buf}(hj)2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!2ubh and/or }(hj!2hhhNhNubj)}(h **tx_buf**h]htx_buf}(hj;2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj!2ubh. In some cases, they may also want to provide DMA addresses for the data being transferred; that may reduce overhead, when the underlying driver uses DMA.}(hj!2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM+hhhhubh)}(hXIf the transmit buffer is NULL, zeroes will be shifted out while filling **rx_buf**. If the receive buffer is NULL, the data shifted in will be discarded. Only "len" bytes shift out (or in). It's an error to try to shift out a partial word. (For example, by shifting out three bytes with word size of sixteen or twenty bits; the former uses two bytes per word, the latter uses four bytes.)h](hIIf the transmit buffer is NULL, zeroes will be shifted out while filling }(hjT2hhhNhNubj)}(h **rx_buf**h]hrx_buf}(hj\2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjT2ubhX;. If the receive buffer is NULL, the data shifted in will be discarded. Only “len” bytes shift out (or in). It’s an error to try to shift out a partial word. (For example, by shifting out three bytes with word size of sixteen or twenty bits; the former uses two bytes per word, the latter uses four bytes.)}(hjT2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM1hhhhubh)}(hXIn-memory data values are always in native CPU byte order, translated from the wire byte order (big-endian except with SPI_LSB_FIRST). So for example when bits_per_word is sixteen, buffers are 2N bytes long (**len** = 2N) and hold N sixteen bit words in CPU byte order.h](hIn-memory data values are always in native CPU byte order, translated from the wire byte order (big-endian except with SPI_LSB_FIRST). So for example when bits_per_word is sixteen, buffers are 2N bytes long (}(hju2hhhNhNubj)}(h**len**h]hlen}(hj}2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhju2ubh6 = 2N) and hold N sixteen bit words in CPU byte order.}(hju2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM8hhhhubh)}(hXWhen the word size of the SPI transfer is not a power-of-two multiple of eight bits, those in-memory words include extra bits. In-memory words are always seen by protocol drivers as right-justified, so the undefined (rx) or unused (tx) bits are always the most significant bits.h]hXWhen the word size of the SPI transfer is not a power-of-two multiple of eight bits, those in-memory words include extra bits. In-memory words are always seen by protocol drivers as right-justified, so the undefined (rx) or unused (tx) bits are always the most significant bits.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM=hhhhubh)}(hAll SPI transfers start with the relevant chipselect active. Normally it stays selected until after the last transfer in a message. Drivers can affect the chipselect signal using cs_change.h]hAll SPI transfers start with the relevant chipselect active. Normally it stays selected until after the last transfer in a message. Drivers can affect the chipselect signal using cs_change.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMBhhhhubh)}(hX.(i) If the transfer isn't the last one in the message, this flag is used to make the chipselect briefly go inactive in the middle of the message. Toggling chipselect in this way may be needed to terminate a chip command, letting a single spi_message perform all of group of chip transactions together.h]hX0(i) If the transfer isn’t the last one in the message, this flag is used to make the chipselect briefly go inactive in the middle of the message. Toggling chipselect in this way may be needed to terminate a chip command, letting a single spi_message perform all of group of chip transactions together.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMFhhhhubh)}(hXM(ii) When the transfer is the last one in the message, the chip may stay selected until the next transfer. On multi-device SPI busses with nothing blocking messages going to other devices, this is just a performance hint; starting a message to another device deselects this one. But in other cases, this can be used to ensure correctness. Some devices need protocol transactions to be built from a series of spi_message submissions, where the content of one message is determined by the results of previous messages and where the whole transaction ends when the chipselect goes inactive.h]hXM(ii) When the transfer is the last one in the message, the chip may stay selected until the next transfer. On multi-device SPI busses with nothing blocking messages going to other devices, this is just a performance hint; starting a message to another device deselects this one. But in other cases, this can be used to ensure correctness. Some devices need protocol transactions to be built from a series of spi_message submissions, where the content of one message is determined by the results of previous messages and where the whole transaction ends when the chipselect goes inactive.}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMLhhhhubh)}(hX,When SPI can transfer in 1x,2x or 4x. It can get this transfer information from device through **tx_nbits** and **rx_nbits**. In Bi-direction, these two should both be set. User can set transfer mode with SPI_NBITS_SINGLE(1x) SPI_NBITS_DUAL(2x) and SPI_NBITS_QUAD(4x) to support these three transfer.h](h_When SPI can transfer in 1x,2x or 4x. It can get this transfer information from device through }(hj2hhhNhNubj)}(h **tx_nbits**h]htx_nbits}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubh and }(hj2hhhNhNubj)}(h **rx_nbits**h]hrx_nbits}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubh. In Bi-direction, these two should both be set. User can set transfer mode with SPI_NBITS_SINGLE(1x) SPI_NBITS_DUAL(2x) and SPI_NBITS_QUAD(4x) to support these three transfer.}(hj2hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMVhhhhubh)}(h|User may also set dtr_mode to true to use dual transfer mode if desired. if not, default considered as single transfer mode.h]h|User may also set dtr_mode to true to use dual transfer mode if desired. if not, default considered as single transfer mode.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM[hhhhubh)}(hX3The code that submits an spi_message (and its spi_transfers) to the lower layers is responsible for managing its memory. Zero-initialize every field you don't set up explicitly, to insulate against future API updates. After you submit a message and its transfers, ignore them until its completion callback.h]hX5The code that submits an spi_message (and its spi_transfers) to the lower layers is responsible for managing its memory. Zero-initialize every field you don’t set up explicitly, to insulate against future API updates. After you submit a message and its transfers, ignore them until its completion callback.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM^hhhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_message (C struct) c.spi_messagehNtauh1jhhhhhjhNubj)}(hhh](j)}(h spi_messageh]j)}(hstruct spi_messageh](j)}(hjh]hstruct}(hj<3hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj83hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMgubj)}(h h]h }(hjJ3hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj83hhhjI3hMgubj$)}(h spi_messageh]j*)}(hj63h]h spi_message}(hj\3hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjX3ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj83hhhjI3hMgubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj43hhhjI3hMgubah}(h]j/3ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjI3hMghj13hhubjX)}(hhh]h)}(h!one multi-segment SPI transactionh]h!one multi-segment SPI transaction}(hj~3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj{3hhubah}(h]h ]h"]h$]h&]uh1jWhj13hhhjI3hMgubeh}(h]h ](jstructeh"]h$]h&]jxjjyj3jzj3j{j|j}uh1jhhhhhjhNubj)}(hX**Definition**:: struct spi_message { struct list_head transfers; struct spi_device *spi; bool pre_optimized; bool optimized; bool prepared; int status; void (*complete)(void *context); void *context; unsigned frame_length; unsigned actual_length; struct list_head queue; void *state; void *opt_state; struct spi_offload *offload; struct list_head resources; }; **Members** ``transfers`` list of transfer segments in this transaction ``spi`` SPI device to which the transaction is queued ``pre_optimized`` peripheral driver pre-optimized the message ``optimized`` the message is in the optimized state ``prepared`` spi_prepare_message was called for the this message ``status`` zero for success, else negative errno ``complete`` called to report transaction completions ``context`` the argument to complete() when it's called ``frame_length`` the total number of bytes in the message ``actual_length`` the total number of bytes that were transferred in all successful segments ``queue`` for use by whichever driver currently owns the message ``state`` for use by whichever driver currently owns the message ``opt_state`` for use by whichever driver currently owns the message ``offload`` (optional) offload instance used by this message ``resources`` for resource management when the SPI message is processedh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubh:}(hj3hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj3ubj)}(hXstruct spi_message { struct list_head transfers; struct spi_device *spi; bool pre_optimized; bool optimized; bool prepared; int status; void (*complete)(void *context); void *context; unsigned frame_length; unsigned actual_length; struct list_head queue; void *state; void *opt_state; struct spi_offload *offload; struct list_head resources; };h]hXstruct spi_message { struct list_head transfers; struct spi_device *spi; bool pre_optimized; bool optimized; bool prepared; int status; void (*complete)(void *context); void *context; unsigned frame_length; unsigned actual_length; struct list_head queue; void *state; void *opt_state; struct spi_offload *offload; struct list_head resources; };}hj3sbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj3ubh)}(h **Members**h]j)}(hj3h]hMembers}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj3ubj)}(hhh](j)}(h<``transfers`` list of transfer segments in this transaction h](j)}(h ``transfers``h]h)}(hj3h]h transfers}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj3ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj3ubj)}(hhh]h)}(h-list of transfer segments in this transactionh]h-list of transfer segments in this transaction}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hMhj4ubah}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ]h"]h$]h&]uh1jhj4hMhj3ubj)}(h6``spi`` SPI device to which the transaction is queued h](j)}(h``spi``h]h)}(hj$4h]hspi}(hj&4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"4ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj4ubj)}(hhh]h)}(h-SPI device to which the transaction is queuedh]h-SPI device to which the transaction is queued}(hj=4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj94hMhj:4ubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhj94hMhj3ubj)}(h>``pre_optimized`` peripheral driver pre-optimized the message h](j)}(h``pre_optimized``h]h)}(hj]4h]h pre_optimized}(hj_4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[4ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjW4ubj)}(hhh]h)}(h+peripheral driver pre-optimized the messageh]h+peripheral driver pre-optimized the message}(hjv4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjr4hMhjs4ubah}(h]h ]h"]h$]h&]uh1jhjW4ubeh}(h]h ]h"]h$]h&]uh1jhjr4hMhj3ubj)}(h4``optimized`` the message is in the optimized state h](j)}(h ``optimized``h]h)}(hj4h]h optimized}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj4ubj)}(hhh]h)}(h%the message is in the optimized stateh]h%the message is in the optimized state}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hMhj4ubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhj4hMhj3ubj)}(hA``prepared`` spi_prepare_message was called for the this message h](j)}(h ``prepared``h]h)}(hj4h]hprepared}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj4ubj)}(hhh]h)}(h3spi_prepare_message was called for the this messageh]h3spi_prepare_message was called for the this message}(hj4hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj4hMhj4ubah}(h]h ]h"]h$]h&]uh1jhj4ubeh}(h]h ]h"]h$]h&]uh1jhj4hMhj3ubj)}(h1``status`` zero for success, else negative errno h](j)}(h ``status``h]h)}(hj5h]hstatus}(hj 5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj5ubj)}(hhh]h)}(h%zero for success, else negative errnoh]h%zero for success, else negative errno}(hj!5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hMhj5ubah}(h]h ]h"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]uh1jhj5hMhj3ubj)}(h6``complete`` called to report transaction completions h](j)}(h ``complete``h]h)}(hjA5h]hcomplete}(hjC5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj?5ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj;5ubj)}(hhh]h)}(h(called to report transaction completionsh]h(called to report transaction completions}(hjZ5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjV5hMhjW5ubah}(h]h ]h"]h$]h&]uh1jhj;5ubeh}(h]h ]h"]h$]h&]uh1jhjV5hMhj3ubj)}(h8``context`` the argument to complete() when it's called h](j)}(h ``context``h]h)}(hjz5h]hcontext}(hj|5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjx5ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt5ubj)}(hhh]h)}(h+the argument to complete() when it's calledh]h-the argument to complete() when it’s called}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hMhj5ubah}(h]h ]h"]h$]h&]uh1jhjt5ubeh}(h]h ]h"]h$]h&]uh1jhj5hMhj3ubj)}(h:``frame_length`` the total number of bytes in the message h](j)}(h``frame_length``h]h)}(hj5h]h frame_length}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj5ubj)}(hhh]h)}(h(the total number of bytes in the messageh]h(the total number of bytes in the message}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5hMhj5ubah}(h]h ]h"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]uh1jhj5hMhj3ubj)}(h]``actual_length`` the total number of bytes that were transferred in all successful segments h](j)}(h``actual_length``h]h)}(hj5h]h actual_length}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj5ubj)}(hhh]h)}(hJthe total number of bytes that were transferred in all successful segmentsh]hJthe total number of bytes that were transferred in all successful segments}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj6ubah}(h]h ]h"]h$]h&]uh1jhj5ubeh}(h]h ]h"]h$]h&]uh1jhj6hMhj3ubj)}(hA``queue`` for use by whichever driver currently owns the message h](j)}(h ``queue``h]h)}(hj&6h]hqueue}(hj(6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj$6ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj 6ubj)}(hhh]h)}(h6for use by whichever driver currently owns the messageh]h6for use by whichever driver currently owns the message}(hj?6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;6hMhj<6ubah}(h]h ]h"]h$]h&]uh1jhj 6ubeh}(h]h ]h"]h$]h&]uh1jhj;6hMhj3ubj)}(hA``state`` for use by whichever driver currently owns the message h](j)}(h ``state``h]h)}(hj_6h]hstate}(hja6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]6ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjY6ubj)}(hhh]h)}(h6for use by whichever driver currently owns the messageh]h6for use by whichever driver currently owns the message}(hjx6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjt6hMhju6ubah}(h]h ]h"]h$]h&]uh1jhjY6ubeh}(h]h ]h"]h$]h&]uh1jhjt6hMhj3ubj)}(hE``opt_state`` for use by whichever driver currently owns the message h](j)}(h ``opt_state``h]h)}(hj6h]h opt_state}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj6ubj)}(hhh]h)}(h6for use by whichever driver currently owns the messageh]h6for use by whichever driver currently owns the message}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hMhj6ubah}(h]h ]h"]h$]h&]uh1jhj6ubeh}(h]h ]h"]h$]h&]uh1jhj6hMhj3ubj)}(h=``offload`` (optional) offload instance used by this message h](j)}(h ``offload``h]h)}(hj6h]hoffload}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj6ubj)}(hhh]h)}(h0(optional) offload instance used by this messageh]h0(optional) offload instance used by this message}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj6hMhj6ubah}(h]h ]h"]h$]h&]uh1jhj6ubeh}(h]h ]h"]h$]h&]uh1jhj6hMhj3ubj)}(hG``resources`` for resource management when the SPI message is processedh](j)}(h ``resources``h]h)}(hj 7h]h resources}(hj 7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj7ubj)}(hhh]h)}(h9for resource management when the SPI message is processedh]h9for resource management when the SPI message is processed}(hj#7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj 7ubah}(h]h ]h"]h$]h&]uh1jhj7ubeh}(h]h ]h"]h$]h&]uh1jhj7hMhj3ubeh}(h]h ]h"]h$]h&]uh1jhj3ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubh)}(h**Description**h]j)}(hjM7h]h Description}(hjO7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjK7ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hXA **spi_message** is used to execute an atomic sequence of data transfers, each represented by a struct spi_transfer. The sequence is "atomic" in the sense that no other spi_message may use that SPI bus until that sequence completes. On some systems, many such sequences can execute as a single programmed DMA transfer. On all systems, these messages are queued, and might complete after transactions to other devices. Messages sent to a given spi_device are always executed in FIFO order.h](hA }(hjc7hhhNhNubj)}(h**spi_message**h]h spi_message}(hjk7hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjc7ubhX is used to execute an atomic sequence of data transfers, each represented by a struct spi_transfer. The sequence is “atomic” in the sense that no other spi_message may use that SPI bus until that sequence completes. On some systems, many such sequences can execute as a single programmed DMA transfer. On all systems, these messages are queued, and might complete after transactions to other devices. Messages sent to a given spi_device are always executed in FIFO order.}(hjc7hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hX3The code that submits an spi_message (and its spi_transfers) to the lower layers is responsible for managing its memory. Zero-initialize every field you don't set up explicitly, to insulate against future API updates. After you submit a message and its transfers, ignore them until its completion callback.h]hX5The code that submits an spi_message (and its spi_transfers) to the lower layers is responsible for managing its memory. Zero-initialize every field you don’t set up explicitly, to insulate against future API updates. After you submit a message and its transfers, ignore them until its completion callback.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j,spi_message_init_with_transfers (C function)!c.spi_message_init_with_transfershNtauh1jhhhhhjhNubj)}(hhh](j)}(hpvoid spi_message_init_with_transfers (struct spi_message *m, struct spi_transfer *xfers, unsigned int num_xfers)h]j)}(hovoid spi_message_init_with_transfers(struct spi_message *m, struct spi_transfer *xfers, unsigned int num_xfers)h](j4)}(hvoidh]hvoid}(hj7hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj7hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7hhhj7hMubj$)}(hspi_message_init_with_transfersh]j*)}(hspi_message_init_with_transfersh]hspi_message_init_with_transfers}(hj7hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj7ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj7hhhj7hMubjl)}(hK(struct spi_message *m, struct spi_transfer *xfers, unsigned int num_xfers)h](jr)}(hstruct spi_message *mh](j)}(hjh]hstruct}(hj7hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj7ubj)}(h h]h }(hj7hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7ubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hj8hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj8ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj 8modnameN classnameNjj)}j]j)}jj7sb!c.spi_message_init_with_transfersasbuh1hhj7ubj)}(h h]h }(hj'8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7ubj)}(hjh]h*}(hj58hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj7ubj*)}(hmh]hm}(hjB8hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj7ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj7ubjr)}(hstruct spi_transfer *xfersh](j)}(hjh]hstruct}(hj[8hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjW8ubj)}(h h]h }(hjh8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW8ubh)}(hhh]j*)}(h spi_transferh]h spi_transfer}(hjy8hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjv8ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj{8modnameN classnameNjj)}j]j#8!c.spi_message_init_with_transfersasbuh1hhjW8ubj)}(h h]h }(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW8ubj)}(hjh]h*}(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW8ubj*)}(hxfersh]hxfers}(hj8hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjW8ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj7ubjr)}(hunsigned int num_xfersh](j4)}(hunsignedh]hunsigned}(hj8hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj8ubj)}(h h]h }(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubj4)}(hinth]hint}(hj8hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj8ubj)}(h h]h }(hj8hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj8ubj*)}(h num_xfersh]h num_xfers}(hj9hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj8ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj7ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhj7hhhj7hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj7hhhj7hMubah}(h]j7ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj7hMhj7hhubjX)}(hhh]h)}(h+Initialize spi_message and append transfersh]h+Initialize spi_message and append transfers}(hj-9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj*9hhubah}(h]h ]h"]h$]h&]uh1jWhj7hhhj7hMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjE9jzjE9j{j|j}uh1jhhhhhjhNubj)}(hXE**Parameters** ``struct spi_message *m`` spi_message to be initialized ``struct spi_transfer *xfers`` An array of SPI transfers ``unsigned int num_xfers`` Number of items in the xfer array **Description** This function initializes the given spi_message and adds each spi_transfer in the given array to the message.h](h)}(h**Parameters**h]j)}(hjO9h]h Parameters}(hjQ9hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjM9ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjI9ubj)}(hhh](j)}(h8``struct spi_message *m`` spi_message to be initialized h](j)}(h``struct spi_message *m``h]h)}(hjn9h]hstruct spi_message *m}(hjp9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjl9ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjh9ubj)}(hhh]h)}(hspi_message to be initializedh]hspi_message to be initialized}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhjh9ubeh}(h]h ]h"]h$]h&]uh1jhj9hMhje9ubj)}(h9``struct spi_transfer *xfers`` An array of SPI transfers h](j)}(h``struct spi_transfer *xfers``h]h)}(hj9h]hstruct spi_transfer *xfers}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj9ubj)}(hhh]h)}(hAn array of SPI transfersh]hAn array of SPI transfers}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhj9ubeh}(h]h ]h"]h$]h&]uh1jhj9hMhje9ubj)}(h=``unsigned int num_xfers`` Number of items in the xfer array h](j)}(h``unsigned int num_xfers``h]h)}(hj9h]hunsigned int num_xfers}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj9ubj)}(hhh]h)}(h!Number of items in the xfer arrayh]h!Number of items in the xfer array}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hMhj9ubah}(h]h ]h"]h$]h&]uh1jhj9ubeh}(h]h ]h"]h$]h&]uh1jhj9hMhje9ubeh}(h]h ]h"]h$]h&]uh1jhjI9ubh)}(h**Description**h]j)}(hj:h]h Description}(hj:hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj:ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjI9ubh)}(hmThis function initializes the given spi_message and adds each spi_transfer in the given array to the message.h]hmThis function initializes the given spi_message and adds each spi_transfer in the given array to the message.}(hj1:hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjI9ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!spi_is_bpw_supported (C function)c.spi_is_bpw_supportedhNtauh1jhhhhhjhNubj)}(hhh](j)}(h;bool spi_is_bpw_supported (struct spi_device *spi, u32 bpw)h]j)}(h:bool spi_is_bpw_supported(struct spi_device *spi, u32 bpw)h](j4)}(hboolh]hbool}(hj`:hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj\:hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMgubj)}(h h]h }(hjo:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\:hhhjn:hMgubj$)}(hspi_is_bpw_supportedh]j*)}(hspi_is_bpw_supportedh]hspi_is_bpw_supported}(hj:hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj}:ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj\:hhhjn:hMgubjl)}(h!(struct spi_device *spi, u32 bpw)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hj:hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj:ubj)}(h h]h }(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hj:hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj:ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj:modnameN classnameNjj)}j]j)}jj:sbc.spi_is_bpw_supportedasbuh1hhj:ubj)}(h h]h }(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubj)}(hjh]h*}(hj:hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj:ubj*)}(hspih]hspi}(hj:hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj:ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj:ubjr)}(hu32 bpwh](h)}(hhh]j*)}(hu32h]hu32}(hj;hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj;ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj;modnameN classnameNjj)}j]j:c.spi_is_bpw_supportedasbuh1hhj ;ubj)}(h h]h }(hj0;hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ;ubj*)}(hbpwh]hbpw}(hj>;hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj ;ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj:ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhj\:hhhjn:hMgubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjX:hhhjn:hMgubah}(h]jS:ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjn:hMghjU:hhubjX)}(hhh]h)}(h#Check if bits per word is supportedh]h#Check if bits per word is supported}(hjh;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMghje;hhubah}(h]h ]h"]h$]h&]uh1jWhjU:hhhjn:hMgubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj;jzj;j{j|j}uh1jhhhhhjhNubj)}(h**Parameters** ``struct spi_device *spi`` SPI device ``u32 bpw`` Bits per word **Description** This function checks to see if the SPI controller supports **bpw**. **Return** True if **bpw** is supported, false otherwise.h](h)}(h**Parameters**h]j)}(hj;h]h Parameters}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj;ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMkhj;ubj)}(hhh](j)}(h&``struct spi_device *spi`` SPI device h](j)}(h``struct spi_device *spi``h]h)}(hj;h]hstruct spi_device *spi}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhj;ubj)}(hhh]h)}(h SPI deviceh]h SPI device}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;hMhhj;ubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhj;hMhhj;ubj)}(h``u32 bpw`` Bits per word h](j)}(h ``u32 bpw``h]h)}(hj;h]hu32 bpw}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMihj;ubj)}(hhh]h)}(h Bits per wordh]h Bits per word}(hj;hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;hMihj;ubah}(h]h ]h"]h$]h&]uh1jhj;ubeh}(h]h ]h"]h$]h&]uh1jhj;hMihj;ubeh}(h]h ]h"]h$]h&]uh1jhj;ubh)}(h**Description**h]j)}(hj<h]h Description}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj<ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMkhj;ubh)}(hCThis function checks to see if the SPI controller supports **bpw**.h](h;This function checks to see if the SPI controller supports }(hj3<hhhNhNubj)}(h**bpw**h]hbpw}(hj;<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3<ubh.}(hj3<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMjhj;ubh)}(h **Return**h]j)}(hjV<h]hReturn}(hjX<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjT<ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMlhj;ubh)}(h.True if **bpw** is supported, false otherwise.h](hTrue if }(hjl<hhhNhNubj)}(h**bpw**h]hbpw}(hjt<hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjl<ubh is supported, false otherwise.}(hjl<hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMmhj;ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_bpw_to_bytes (C function)c.spi_bpw_to_byteshNtauh1jhhhhhjhNubj)}(hhh](j)}(hu32 spi_bpw_to_bytes (u32 bpw)h]j)}(hu32 spi_bpw_to_bytes(u32 bpw)h](h)}(hhh]j*)}(hu32h]hu32}(hj<hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj<ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj<modnameN classnameNjj)}j]j)}jspi_bpw_to_bytessbc.spi_bpw_to_bytesasbuh1hhj<hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM{ubj)}(h h]h }(hj<hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<hhhj<hM{ubj$)}(hspi_bpw_to_bytesh]j*)}(hj<h]hspi_bpw_to_bytes}(hj<hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj<ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj<hhhj<hM{ubjl)}(h (u32 bpw)h]jr)}(hu32 bpwh](h)}(hhh]j*)}(hu32h]hu32}(hj=hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj<ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj=modnameN classnameNjj)}j]j<c.spi_bpw_to_bytesasbuh1hhj<ubj)}(h h]h }(hj =hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<ubj*)}(hbpwh]hbpw}(hj.=hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj<ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj<ubah}(h]h ]h"]h$]h&]jAjBuh1jkhj<hhhj<hM{ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj<hhhj<hM{ubah}(h]j<ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj<hM{hj<hhubjX)}(hhh]h)}(hCovert bits per word to bytesh]hCovert bits per word to bytes}(hjX=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM{hjU=hhubah}(h]h ]h"]h$]h&]uh1jWhj<hhhj<hM{ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjp=jzjp=j{j|j}uh1jhhhhhjhNubj)}(hX**Parameters** ``u32 bpw`` Bits per word **Description** This function converts the given **bpw** to bytes. The result is always power-of-two, e.g., =============== ================= Input (in bits) Output (in bytes) =============== ================= 5 1 9 2 21 4 37 8 =============== ================= It will return 0 for the 0 input. **Return** Bytes for the given **bpw**.h](h)}(h**Parameters**h]j)}(hjz=h]h Parameters}(hj|=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjx=ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt=ubj)}(hhh]j)}(h``u32 bpw`` Bits per word h](j)}(h ``u32 bpw``h]h)}(hj=h]hu32 bpw}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM|hj=ubj)}(hhh]h)}(h Bits per wordh]h Bits per word}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=hM|hj=ubah}(h]h ]h"]h$]h&]uh1jhj=ubeh}(h]h ]h"]h$]h&]uh1jhj=hM|hj=ubah}(h]h ]h"]h$]h&]uh1jhjt=ubh)}(h**Description**h]j)}(hj=h]h Description}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM~hjt=ubh)}(h[This function converts the given **bpw** to bytes. The result is always power-of-two, e.g.,h](h!This function converts the given }(hj=hhhNhNubj)}(h**bpw**h]hbpw}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj=ubh3 to bytes. The result is always power-of-two, e.g.,}(hj=hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM}hjt=ubj)}(hX =============== ================= Input (in bits) Output (in bytes) =============== ================= 5 1 9 2 21 4 37 8 =============== ================= h]htable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j>hj>ubj>)}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j>hj>ubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(hInput (in bits)h]hInput (in bits)}(hj>>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj;>ubah}(h]h ]h"]h$]h&]uh1j9>hj6>ubj:>)}(hhh]h)}(hOutput (in bytes)h]hOutput (in bytes)}(hjV>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjL>hMhjS>ubah}(h]h ]h"]h$]h&]uh1j9>hj6>ubeh}(h]h ]h"]h$]h&]uh1j4>hj1>ubah}(h]h ]h"]h$]h&]uh1j/>hj>ubhtbody)}(hhh](j5>)}(hhh](j:>)}(hhh]h)}(h5h]h5}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~>ubah}(h]h ]h"]h$]h&]uh1j9>hj{>ubj:>)}(hhh]h)}(h1h]h1}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hMhj>ubah}(h]h ]h"]h$]h&]uh1j9>hj{>ubeh}(h]h ]h"]h$]h&]uh1j4>hjx>ubj5>)}(hhh](j:>)}(hhh]h)}(h9h]h9}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj>ubah}(h]h ]h"]h$]h&]uh1j9>hj>ubj:>)}(hhh]h)}(h2h]h2}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hMhj>ubah}(h]h ]h"]h$]h&]uh1j9>hj>ubeh}(h]h ]h"]h$]h&]uh1j4>hjx>ubj5>)}(hhh](j:>)}(hhh]h)}(h21h]h21}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj>ubah}(h]h ]h"]h$]h&]uh1j9>hj>ubj:>)}(hhh]h)}(h4h]h4}(hj ?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj>hMhj?ubah}(h]h ]h"]h$]h&]uh1j9>hj>ubeh}(h]h ]h"]h$]h&]uh1j4>hjx>ubj5>)}(hhh](j:>)}(hhh]h)}(h37h]h37}(hj)?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj&?ubah}(h]h ]h"]h$]h&]uh1j9>hj#?ubj:>)}(hhh]h)}(h8h]h8}(hjA?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7?hMhj>?ubah}(h]h ]h"]h$]h&]uh1j9>hj#?ubeh}(h]h ]h"]h$]h&]uh1j4>hjx>ubeh}(h]h ]h"]h$]h&]uh1jv>hj>ubeh}(h]h ]h"]h$]h&]colsKuh1j>hj>ubah}(h]h ]h"]h$]h&]uh1j>hj >ubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt=ubh)}(h!It will return 0 for the 0 input.h]h!It will return 0 for the 0 input.}(hju?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt=ubh)}(h **Return**h]j)}(hj?h]hReturn}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt=ubh)}(hBytes for the given **bpw**.h](hBytes for the given }(hj?hhhNhNubj)}(h**bpw**h]hbpw}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubh.}(hj?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjt=ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(spi_controller_xfer_timeout (C function)c.spi_controller_xfer_timeouthNtauh1jhhhhhjhNubj)}(hhh](j)}(haunsigned int spi_controller_xfer_timeout (struct spi_controller *ctlr, struct spi_transfer *xfer)h]j)}(h`unsigned int spi_controller_xfer_timeout(struct spi_controller *ctlr, struct spi_transfer *xfer)h](j4)}(hunsignedh]hunsigned}(hj?hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj?hhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hj?hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?hhhj?hMubj4)}(hinth]hint}(hj?hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj?hhhj?hMubj)}(h h]h }(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?hhhj?hMubj$)}(hspi_controller_xfer_timeouth]j*)}(hspi_controller_xfer_timeouth]hspi_controller_xfer_timeout}(hj@hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj@ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj?hhhj?hMubjl)}(h8(struct spi_controller *ctlr, struct spi_transfer *xfer)h](jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hj6@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj2@ubj)}(h h]h }(hjC@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2@ubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjT@hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjQ@ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjV@modnameN classnameNjj)}j]j)}jj@sbc.spi_controller_xfer_timeoutasbuh1hhj2@ubj)}(h h]h }(hjt@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2@ubj)}(hjh]h*}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj2@ubj*)}(hctlrh]hctlr}(hj@hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj2@ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj.@ubjr)}(hstruct spi_transfer *xferh](j)}(hjh]hstruct}(hj@hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj@ubj)}(h h]h }(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@ubh)}(hhh]j*)}(h spi_transferh]h spi_transfer}(hj@hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj@ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj@modnameN classnameNjj)}j]jp@c.spi_controller_xfer_timeoutasbuh1hhj@ubj)}(h h]h }(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@ubj)}(hjh]h*}(hj@hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj@ubj*)}(hxferh]hxfer}(hj@hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj@ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj.@ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhj?hhhj?hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj?hhhj?hMubah}(h]j?ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj?hMhj?hhubjX)}(hhh]h)}(h Compute a suitable timeout valueh]h Compute a suitable timeout value}(hj)AhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj&Ahhubah}(h]h ]h"]h$]h&]uh1jWhj?hhhj?hMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjAAjzjAAj{j|j}uh1jhhhhhjhNubj)}(hX**Parameters** ``struct spi_controller *ctlr`` SPI device ``struct spi_transfer *xfer`` Transfer descriptor **Description** Compute a relevant timeout value for the given transfer. We derive the time that it would take on a single data line and take twice this amount of time with a minimum of 500ms to avoid false positives on loaded systems. **Return** Transfer timeout value in milliseconds.h](h)}(h**Parameters**h]j)}(hjKAh]h Parameters}(hjMAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIAubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjEAubj)}(hhh](j)}(h+``struct spi_controller *ctlr`` SPI device h](j)}(h``struct spi_controller *ctlr``h]h)}(hjjAh]hstruct spi_controller *ctlr}(hjlAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhAubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjdAubj)}(hhh]h)}(h SPI deviceh]h SPI device}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMhjAubah}(h]h ]h"]h$]h&]uh1jhjdAubeh}(h]h ]h"]h$]h&]uh1jhjAhMhjaAubj)}(h2``struct spi_transfer *xfer`` Transfer descriptor h](j)}(h``struct spi_transfer *xfer``h]h)}(hjAh]hstruct spi_transfer *xfer}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjAubj)}(hhh]h)}(hTransfer descriptorh]hTransfer descriptor}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAhMhjAubah}(h]h ]h"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]uh1jhjAhMhjaAubeh}(h]h ]h"]h$]h&]uh1jhjEAubh)}(h**Description**h]j)}(hjAh]h Description}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjEAubh)}(hCompute a relevant timeout value for the given transfer. We derive the time that it would take on a single data line and take twice this amount of time with a minimum of 500ms to avoid false positives on loaded systems.h]hCompute a relevant timeout value for the given transfer. We derive the time that it would take on a single data line and take twice this amount of time with a minimum of 500ms to avoid false positives on loaded systems.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjEAubh)}(h **Return**h]j)}(hjBh]hReturn}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjEAubh)}(h'Transfer timeout value in milliseconds.h]h'Transfer timeout value in milliseconds.}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjEAubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j!spi_replaced_transfers (C struct)c.spi_replaced_transfershNtauh1jhhhhhjhNubj)}(hhh](j)}(hspi_replaced_transfersh]j)}(hstruct spi_replaced_transfersh](j)}(hjh]hstruct}(hjJBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjFBhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hjXBhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjFBhhhjWBhMubj$)}(hspi_replaced_transfersh]j*)}(hjDBh]hspi_replaced_transfers}(hjjBhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjfBubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjFBhhhjWBhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjBBhhhjWBhMubah}(h]j=Bah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjWBhMhj?BhhubjX)}(hhh]h)}(hcstructure describing the spi_transfer replacements that have occurred so that they can get revertedh]hcstructure describing the spi_transfer replacements that have occurred so that they can get reverted}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjBhhubah}(h]h ]h"]h$]h&]uh1jWhj?BhhhjWBhMubeh}(h]h ](jstructeh"]h$]h&]jxjjyjBjzjBj{j|j}uh1jhhhhhjhNubj)}(hX **Definition**:: struct spi_replaced_transfers { spi_replaced_release_t release; void *extradata; struct list_head replaced_transfers; struct list_head *replaced_after; size_t inserted; struct spi_transfer inserted_transfers[]; }; **Members** ``release`` some extra release code to get executed prior to releasing this structure ``extradata`` pointer to some extra data if requested or NULL ``replaced_transfers`` transfers that have been replaced and which need to get restored ``replaced_after`` the transfer after which the **replaced_transfers** are to get re-inserted ``inserted`` number of transfers inserted ``inserted_transfers`` array of spi_transfers of array-size **inserted**, that have been replacing replaced_transfersh](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubh:}(hjBhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjBubj)}(hstruct spi_replaced_transfers { spi_replaced_release_t release; void *extradata; struct list_head replaced_transfers; struct list_head *replaced_after; size_t inserted; struct spi_transfer inserted_transfers[]; };h]hstruct spi_replaced_transfers { spi_replaced_release_t release; void *extradata; struct list_head replaced_transfers; struct list_head *replaced_after; size_t inserted; struct spi_transfer inserted_transfers[]; };}hjBsbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjBubh)}(h **Members**h]j)}(hjBh]hMembers}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjBubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjBubj)}(hhh](j)}(hV``release`` some extra release code to get executed prior to releasing this structure h](j)}(h ``release``h]h)}(hjBh]hrelease}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjBubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjBubj)}(hhh]h)}(hIsome extra release code to get executed prior to releasing this structureh]hIsome extra release code to get executed prior to releasing this structure}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjCubah}(h]h ]h"]h$]h&]uh1jhjBubeh}(h]h ]h"]h$]h&]uh1jhjChMhjBubj)}(h>``extradata`` pointer to some extra data if requested or NULL h](j)}(h ``extradata``h]h)}(hj3Ch]h extradata}(hj5ChhhNhNubah}(h]h ]h"]h$]h&]uh1hhj1Cubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-Cubj)}(hhh]h)}(h/pointer to some extra data if requested or NULLh]h/pointer to some extra data if requested or NULL}(hjLChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjHChMhjICubah}(h]h ]h"]h$]h&]uh1jhj-Cubeh}(h]h ]h"]h$]h&]uh1jhjHChMhjBubj)}(hX``replaced_transfers`` transfers that have been replaced and which need to get restored h](j)}(h``replaced_transfers``h]h)}(hjlCh]hreplaced_transfers}(hjnChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjCubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjfCubj)}(hhh]h)}(h@transfers that have been replaced and which need to get restoredh]h@transfers that have been replaced and which need to get restored}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjCubah}(h]h ]h"]h$]h&]uh1jhjfCubeh}(h]h ]h"]h$]h&]uh1jhjChMhjBubj)}(h^``replaced_after`` the transfer after which the **replaced_transfers** are to get re-inserted h](j)}(h``replaced_after``h]h)}(hjCh]hreplaced_after}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjCubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjCubj)}(hhh]h)}(hJthe transfer after which the **replaced_transfers** are to get re-insertedh](hthe transfer after which the }(hjChhhNhNubj)}(h**replaced_transfers**h]hreplaced_transfers}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhjCubh are to get re-inserted}(hjChhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjCubah}(h]h ]h"]h$]h&]uh1jhjCubeh}(h]h ]h"]h$]h&]uh1jhjChMhjBubj)}(h*``inserted`` number of transfers inserted h](j)}(h ``inserted``h]h)}(hjCh]hinserted}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1hhjCubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjCubj)}(hhh]h)}(hnumber of transfers insertedh]hnumber of transfers inserted}(hj DhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjDhMhjDubah}(h]h ]h"]h$]h&]uh1jhjCubeh}(h]h ]h"]h$]h&]uh1jhjDhMhjBubj)}(hu``inserted_transfers`` array of spi_transfers of array-size **inserted**, that have been replacing replaced_transfersh](j)}(h``inserted_transfers``h]h)}(hj+Dh]hinserted_transfers}(hj-DhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)Dubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj%Dubj)}(hhh]h)}(h^array of spi_transfers of array-size **inserted**, that have been replacing replaced_transfersh](h%array of spi_transfers of array-size }(hjDDhhhNhNubj)}(h **inserted**h]hinserted}(hjLDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDDubh-, that have been replacing replaced_transfers}(hjDDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhj@DhMhjADubah}(h]h ]h"]h$]h&]uh1jhj%Dubeh}(h]h ]h"]h$]h&]uh1jhj@DhMhjBubeh}(h]h ]h"]h$]h&]uh1jhjBubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubh)}(h**Note**h]j)}(hjDh]hNote}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}Dubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hthat **extradata** will point to **inserted_transfers**[**inserted**] if some extra allocation is requested, so alignment will be the same as for spi_transfers.h](hthat }(hjDhhhNhNubj)}(h **extradata**h]h extradata}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubh will point to }(hjDhhhNhNubj)}(h#**inserted_transfers**[**inserted**h]hinserted_transfers**[**inserted}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjDubh\] if some extra allocation is requested, so alignment will be the same as for spi_transfers.}(hjDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_sync_transfer (C function)c.spi_sync_transferhNtauh1jhhhhhjhNubj)}(hhh](j)}(hbint spi_sync_transfer (struct spi_device *spi, struct spi_transfer *xfers, unsigned int num_xfers)h]j)}(haint spi_sync_transfer(struct spi_device *spi, struct spi_transfer *xfers, unsigned int num_xfers)h](j4)}(hinth]hint}(hjDhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjDhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hjDhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjDhhhjDhMubj$)}(hspi_sync_transferh]j*)}(hspi_sync_transferh]hspi_sync_transfer}(hjEhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjDubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjDhhhjDhMubjl)}(hL(struct spi_device *spi, struct spi_transfer *xfers, unsigned int num_xfers)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjEubj)}(h h]h }(hj+EhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjEmodnameN classnameNjj)}j]j)}jjEsbc.spi_sync_transferasbuh1hhjEubj)}(h h]h }(hj\EhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj)}(hjh]h*}(hjjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj*)}(hspih]hspi}(hjwEhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjEubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjEubjr)}(hstruct spi_transfer *xfersh](j)}(hjh]hstruct}(hjEhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjEubj)}(h h]h }(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubh)}(hhh]j*)}(h spi_transferh]h spi_transfer}(hjEhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjEubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjEmodnameN classnameNjj)}j]jXEc.spi_sync_transferasbuh1hhjEubj)}(h h]h }(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj)}(hjh]h*}(hjEhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj*)}(hxfersh]hxfers}(hjEhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjEubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjEubjr)}(hunsigned int num_xfersh](j4)}(hunsignedh]hunsigned}(hjFhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjEubj)}(h h]h }(hjFhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj4)}(hinth]hint}(hjFhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjEubj)}(h h]h }(hj*FhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEubj*)}(h num_xfersh]h num_xfers}(hj8FhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjEubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjEubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjDhhhjDhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjDhhhjDhMubah}(h]jDah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjDhMhjDhhubjX)}(hhh]h)}(hsynchronous SPI data transferh]hsynchronous SPI data transfer}(hjbFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj_Fhhubah}(h]h ]h"]h$]h&]uh1jWhjDhhhjDhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjzFjzjzFj{j|j}uh1jhhhhhjhNubj)}(hX**Parameters** ``struct spi_device *spi`` device with which data will be exchanged ``struct spi_transfer *xfers`` An array of spi_transfers ``unsigned int num_xfers`` Number of items in the xfer array **Context** can sleep **Description** Does a synchronous SPI data transfer of the given spi_transfer array. For more specific semantics see spi_sync(). **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjFh]h Parameters}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubj)}(hhh](j)}(hD``struct spi_device *spi`` device with which data will be exchanged h](j)}(h``struct spi_device *spi``h]h)}(hjFh]hstruct spi_device *spi}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjFubj)}(hhh]h)}(h(device with which data will be exchangedh]h(device with which data will be exchanged}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhMhjFubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhjFhMhjFubj)}(h9``struct spi_transfer *xfers`` An array of spi_transfers h](j)}(h``struct spi_transfer *xfers``h]h)}(hjFh]hstruct spi_transfer *xfers}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjFubj)}(hhh]h)}(hAn array of spi_transfersh]hAn array of spi_transfers}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFhMhjFubah}(h]h ]h"]h$]h&]uh1jhjFubeh}(h]h ]h"]h$]h&]uh1jhjFhMhjFubj)}(h=``unsigned int num_xfers`` Number of items in the xfer array h](j)}(h``unsigned int num_xfers``h]h)}(hjGh]hunsigned int num_xfers}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjGubj)}(hhh]h)}(h!Number of items in the xfer arrayh]h!Number of items in the xfer array}(hj.GhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*GhMhj+Gubah}(h]h ]h"]h$]h&]uh1jhjGubeh}(h]h ]h"]h$]h&]uh1jhj*GhMhjFubeh}(h]h ]h"]h$]h&]uh1jhj~Fubh)}(h **Context**h]j)}(hjPGh]hContext}(hjRGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNGubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubh)}(h can sleeph]h can sleep}(hjfGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubh)}(h**Description**h]j)}(hjwGh]h Description}(hjyGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuGubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubh)}(hEDoes a synchronous SPI data transfer of the given spi_transfer array.h]hEDoes a synchronous SPI data transfer of the given spi_transfer array.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubh)}(h+For more specific semantics see spi_sync().h]h+For more specific semantics see spi_sync().}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubh)}(h **Return**h]j)}(hjGh]hReturn}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjGubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj~Fubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_write (C function) c.spi_writehNtauh1jhhhhhjhNubj)}(hhh](j)}(hCint spi_write (struct spi_device *spi, const void *buf, size_t len)h]j)}(hBint spi_write(struct spi_device *spi, const void *buf, size_t len)h](j4)}(hinth]hint}(hjGhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjGhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMubj)}(h h]h }(hjHhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjGhhhjHhMubj$)}(h spi_writeh]j*)}(h spi_writeh]h spi_write}(hjHhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjHubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjGhhhjHhMubjl)}(h5(struct spi_device *spi, const void *buf, size_t len)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hj/HhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj+Hubj)}(h h]h }(hjSPI synchronous 8 bit write followed by 16 bit big-endian readh]h>SPI synchronous 8 bit write followed by 16 bit big-endian read}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM\hjShhubah}(h]h ]h"]h$]h&]uh1jWhjRhhhjRhM\ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjSjzjSj{j|j}uh1jhhhhhjhNubj)}(hX**Parameters** ``struct spi_device *spi`` device with which data will be exchanged ``u8 cmd`` command to be written before data is read back **Context** can sleep **Description** This function is similar to spi_w8r16, with the exception that it will convert the read 16 bit data word from big-endian to native endianness. Callable only from contexts that can sleep. **Return** the (unsigned) sixteen bit number returned by the device in CPU endianness, or else a negative error code.h](h)}(h**Parameters**h]j)}(hjSh]h Parameters}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM`hjSubj)}(hhh](j)}(hD``struct spi_device *spi`` device with which data will be exchanged h](j)}(h``struct spi_device *spi``h]h)}(hjSh]hstruct spi_device *spi}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhjSubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM]hjSubj)}(hhh]h)}(h(device with which data will be exchangedh]h(device with which data will be exchanged}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhjThM]hjTubah}(h]h ]h"]h$]h&]uh1jhjSubeh}(h]h ]h"]h$]h&]uh1jhjThM]hjSubj)}(h:``u8 cmd`` command to be written before data is read back h](j)}(h ``u8 cmd``h]h)}(hj2Th]hu8 cmd}(hj4ThhhNhNubah}(h]h ]h"]h$]h&]uh1hhj0Tubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM^hj,Tubj)}(hhh]h)}(h.command to be written before data is read backh]h.command to be written before data is read back}(hjKThhhNhNubah}(h]h ]h"]h$]h&]uh1hhjGThM^hjHTubah}(h]h ]h"]h$]h&]uh1jhj,Tubeh}(h]h ]h"]h$]h&]uh1jhjGThM^hjSubeh}(h]h ]h"]h$]h&]uh1jhjSubh)}(h **Context**h]j)}(hjmTh]hContext}(hjoThhhNhNubah}(h]h ]h"]h$]h&]uh1jhjkTubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM`hjSubh)}(h can sleeph]h can sleep}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM_hjSubh)}(h**Description**h]j)}(hjTh]h Description}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMahjSubh)}(hThis function is similar to spi_w8r16, with the exception that it will convert the read 16 bit data word from big-endian to native endianness.h]hThis function is similar to spi_w8r16, with the exception that it will convert the read 16 bit data word from big-endian to native endianness.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhM`hjSubh)}(h+Callable only from contexts that can sleep.h]h+Callable only from contexts that can sleep.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMchjSubh)}(h **Return**h]j)}(hjTh]hReturn}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1jhjTubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMehjSubh)}(hjthe (unsigned) sixteen bit number returned by the device in CPU endianness, or else a negative error code.h]hjthe (unsigned) sixteen bit number returned by the device in CPU endianness, or else a negative error code.}(hjThhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMfhjSubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_board_info (C struct)c.spi_board_infohNtauh1jhhhhhjhNubj)}(hhh](j)}(hspi_board_infoh]j)}(hstruct spi_board_infoh](j)}(hjh]hstruct}(hjUhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj UhhhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMlubj)}(h h]h }(hjUhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj UhhhjUhMlubj$)}(hspi_board_infoh]j*)}(hj Uh]hspi_board_info}(hj/UhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj+Uubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj UhhhjUhMlubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjUhhhjUhMlubah}(h]jUah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjUhMlhjUhhubjX)}(hhh]h)}(h(board-specific template for a SPI deviceh]h(board-specific template for a SPI device}(hjQUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjNUhhubah}(h]h ]h"]h$]h&]uh1jWhjUhhhjUhMlubeh}(h]h ](jstructeh"]h$]h&]jxjjyjiUjzjiUj{j|j}uh1jhhhhhjhNubj)}(hX**Definition**:: struct spi_board_info { char modalias[SPI_NAME_SIZE]; const void *platform_data; const struct software_node *swnode; void *controller_data; int irq; u32 max_speed_hz; u16 bus_num; u16 chip_select; u32 mode; }; **Members** ``modalias`` Initializes spi_device.modalias; identifies the driver. ``platform_data`` Initializes spi_device.platform_data; the particular data stored there is driver-specific. ``swnode`` Software node for the device. ``controller_data`` Initializes spi_device.controller_data; some controllers need hints about hardware setup, e.g. for DMA. ``irq`` Initializes spi_device.irq; depends on how the board is wired. ``max_speed_hz`` Initializes spi_device.max_speed_hz; based on limits from the chip datasheet and board-specific signal quality issues. ``bus_num`` Identifies which spi_controller parents the spi_device; unused by spi_new_device(), and otherwise depends on board wiring. ``chip_select`` Initializes spi_device.chip_select; depends on how the board is wired. ``mode`` Initializes spi_device.mode; based on the chip datasheet, board wiring (some devices support both 3WIRE and standard modes), and possibly presence of an inverter in the chipselect path.h](h)}(h**Definition**::h](j)}(h**Definition**h]h Definition}(hjuUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqUubh:}(hjqUhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjmUubj)}(hstruct spi_board_info { char modalias[SPI_NAME_SIZE]; const void *platform_data; const struct software_node *swnode; void *controller_data; int irq; u32 max_speed_hz; u16 bus_num; u16 chip_select; u32 mode; };h]hstruct spi_board_info { char modalias[SPI_NAME_SIZE]; const void *platform_data; const struct software_node *swnode; void *controller_data; int irq; u32 max_speed_hz; u16 bus_num; u16 chip_select; u32 mode; };}hjUsbah}(h]h ]h"]h$]h&]jAjBuh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjmUubh)}(h **Members**h]j)}(hjUh]hMembers}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjUubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjmUubj)}(hhh](j)}(hE``modalias`` Initializes spi_device.modalias; identifies the driver. h](j)}(h ``modalias``h]h)}(hjUh]hmodalias}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjUubj)}(hhh]h)}(h7Initializes spi_device.modalias; identifies the driver.h]h7Initializes spi_device.modalias; identifies the driver.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUhMhjUubah}(h]h ]h"]h$]h&]uh1jhjUubeh}(h]h ]h"]h$]h&]uh1jhjUhMhjUubj)}(hm``platform_data`` Initializes spi_device.platform_data; the particular data stored there is driver-specific. h](j)}(h``platform_data``h]h)}(hjUh]h platform_data}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjUubj)}(hhh]h)}(hZInitializes spi_device.platform_data; the particular data stored there is driver-specific.h]hZInitializes spi_device.platform_data; the particular data stored there is driver-specific.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj Vubah}(h]h ]h"]h$]h&]uh1jhjUubeh}(h]h ]h"]h$]h&]uh1jhj VhMhjUubj)}(h)``swnode`` Software node for the device. h](j)}(h ``swnode``h]h)}(hj1Vh]hswnode}(hj3VhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/Vubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj+Vubj)}(hhh]h)}(hSoftware node for the device.h]hSoftware node for the device.}(hjJVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjFVhMhjGVubah}(h]h ]h"]h$]h&]uh1jhj+Vubeh}(h]h ]h"]h$]h&]uh1jhjFVhMhjUubj)}(h|``controller_data`` Initializes spi_device.controller_data; some controllers need hints about hardware setup, e.g. for DMA. h](j)}(h``controller_data``h]h)}(hjjVh]hcontroller_data}(hjlVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhVubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjdVubj)}(hhh]h)}(hgInitializes spi_device.controller_data; some controllers need hints about hardware setup, e.g. for DMA.h]hgInitializes spi_device.controller_data; some controllers need hints about hardware setup, e.g. for DMA.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjVubah}(h]h ]h"]h$]h&]uh1jhjdVubeh}(h]h ]h"]h$]h&]uh1jhjVhMhjUubj)}(hG``irq`` Initializes spi_device.irq; depends on how the board is wired. h](j)}(h``irq``h]h)}(hjVh]hirq}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjVubj)}(hhh]h)}(h>Initializes spi_device.irq; depends on how the board is wired.h]h>Initializes spi_device.irq; depends on how the board is wired.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVhMhjVubah}(h]h ]h"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]uh1jhjVhMhjUubj)}(h``max_speed_hz`` Initializes spi_device.max_speed_hz; based on limits from the chip datasheet and board-specific signal quality issues. h](j)}(h``max_speed_hz``h]h)}(hjVh]h max_speed_hz}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjVubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjVubj)}(hhh]h)}(hvInitializes spi_device.max_speed_hz; based on limits from the chip datasheet and board-specific signal quality issues.h]hvInitializes spi_device.max_speed_hz; based on limits from the chip datasheet and board-specific signal quality issues.}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjVubah}(h]h ]h"]h$]h&]uh1jhjVubeh}(h]h ]h"]h$]h&]uh1jhjVhMhjUubj)}(h``bus_num`` Identifies which spi_controller parents the spi_device; unused by spi_new_device(), and otherwise depends on board wiring. h](j)}(h ``bus_num``h]h)}(hjWh]hbus_num}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjWubj)}(hhh]h)}(hzIdentifies which spi_controller parents the spi_device; unused by spi_new_device(), and otherwise depends on board wiring.h]hzIdentifies which spi_controller parents the spi_device; unused by spi_new_device(), and otherwise depends on board wiring.}(hj0WhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhj-Wubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jhj,WhMhjUubj)}(hW``chip_select`` Initializes spi_device.chip_select; depends on how the board is wired. h](j)}(h``chip_select``h]h)}(hjQWh]h chip_select}(hjSWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjOWubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjKWubj)}(hhh]h)}(hFInitializes spi_device.chip_select; depends on how the board is wired.h]hFInitializes spi_device.chip_select; depends on how the board is wired.}(hjjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjgWubah}(h]h ]h"]h$]h&]uh1jhjKWubeh}(h]h ]h"]h$]h&]uh1jhjfWhMhjUubj)}(h``mode`` Initializes spi_device.mode; based on the chip datasheet, board wiring (some devices support both 3WIRE and standard modes), and possibly presence of an inverter in the chipselect path.h](j)}(h``mode``h]h)}(hjWh]hmode}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjWubah}(h]h ]h"]h$]h&]uh1jhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjWubj)}(hhh]h)}(hInitializes spi_device.mode; based on the chip datasheet, board wiring (some devices support both 3WIRE and standard modes), and possibly presence of an inverter in the chipselect path.h]hInitializes spi_device.mode; based on the chip datasheet, board wiring (some devices support both 3WIRE and standard modes), and possibly presence of an inverter in the chipselect path.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhjWubah}(h]h ]h"]h$]h&]uh1jhjWubeh}(h]h ]h"]h$]h&]uh1jhjWhMhjUubeh}(h]h ]h"]h$]h&]uh1jhjmUubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhjhNubh)}(h**Description**h]j)}(hjWh]h Description}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjWubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hXWhen adding new SPI devices to the device tree, these structures serve as a partial device template. They hold information which can't always be determined by drivers. Information that probe() can establish (such as the default transfer wordsize) is not included here.h]hXWhen adding new SPI devices to the device tree, these structures serve as a partial device template. They hold information which can’t always be determined by drivers. Information that probe() can establish (such as the default transfer wordsize) is not included here.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubh)}(hXThese structures are used in two places. Their primary role is to be stored in tables of board-specific device descriptors, which are declared early in board initialization and then used (much later) to populate a controller's device tree after the that controller's driver initializes. A secondary (and atypical) role is as a parameter to spi_new_device() call, which happens after those controller drivers are active in some dynamic board configuration models.h]hXThese structures are used in two places. Their primary role is to be stored in tables of board-specific device descriptors, which are declared early in board initialization and then used (much later) to populate a controller’s device tree after the that controller’s driver initializes. A secondary (and atypical) role is as a parameter to spi_new_device() call, which happens after those controller drivers are active in some dynamic board configuration models.}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhV/var/lib/git/docbuild/linux/Documentation/driver-api/spi:46: ./include/linux/spi/spi.hhMhhhhubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$spi_register_board_info (C function)c.spi_register_board_infohNtauh1jhhhhhNhNubj)}(hhh](j)}(hKint spi_register_board_info (struct spi_board_info const *info, unsigned n)h]j)}(hJint spi_register_board_info(struct spi_board_info const *info, unsigned n)h](j4)}(hinth]hint}(hjXhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjXhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMQubj)}(h h]h }(hj*XhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXhhhj)XhMQubj$)}(hspi_register_board_infoh]j*)}(hspi_register_board_infoh]hspi_register_board_info}(hjXsbc.spi_register_board_infoasbuh1hhjTXubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTXubj)}(hjHh]hconst}(hjXhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjTXubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTXubj)}(hjh]h*}(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjTXubj*)}(hinfoh]hinfo}(hjXhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjTXubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjPXubjr)}(h unsigned nh](j4)}(hunsignedh]hunsigned}(hjXhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjXubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubj*)}(hj5h]hn}(hjYhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjXubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjPXubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjXhhhj)XhMQubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjXhhhj)XhMQubah}(h]jXah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj)XhMQhjXhhubjX)}(hhh]h)}(h®ister SPI devices for a given boardh]h®ister SPI devices for a given board}(hj*YhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMQhj'Yhhubah}(h]h ]h"]h$]h&]uh1jWhjXhhhj)XhMQubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjBYjzjBYj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_board_info const *info`` array of chip descriptors ``unsigned n`` how many descriptors are provided **Context** can sleep **Description** Board-specific early init code calls this (probably during arch_initcall) with segments of the SPI device table. Any device nodes are created later, after the relevant parent SPI controller (bus_num) is defined. We keep this table of devices forever, so that reloading a controller driver will not make Linux forget about these hard-wired devices. Other code can also call this, e.g. a particular add-on board might provide SPI devices through its expansion connector, so code initializing that board would naturally declare its SPI devices. The board info passed can safely be __initdata ... but be careful of any embedded pointers (platform_data, etc), they're copied as-is. **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjLYh]h Parameters}(hjNYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjJYubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMUhjFYubj)}(hhh](j)}(h@``struct spi_board_info const *info`` array of chip descriptors h](j)}(h%``struct spi_board_info const *info``h]h)}(hjkYh]h!struct spi_board_info const *info}(hjmYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjiYubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMRhjeYubj)}(hhh]h)}(harray of chip descriptorsh]harray of chip descriptors}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYhMRhjYubah}(h]h ]h"]h$]h&]uh1jhjeYubeh}(h]h ]h"]h$]h&]uh1jhjYhMRhjbYubj)}(h1``unsigned n`` how many descriptors are provided h](j)}(h``unsigned n``h]h)}(hjYh]h unsigned n}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMShjYubj)}(hhh]h)}(h!how many descriptors are providedh]h!how many descriptors are provided}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYhMShjYubah}(h]h ]h"]h$]h&]uh1jhjYubeh}(h]h ]h"]h$]h&]uh1jhjYhMShjbYubeh}(h]h ]h"]h$]h&]uh1jhjFYubh)}(h **Context**h]j)}(hjYh]hContext}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMUhjFYubh)}(h can sleeph]h can sleep}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMThjFYubh)}(h**Description**h]j)}(hjZh]h Description}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMVhjFYubh)}(hX]Board-specific early init code calls this (probably during arch_initcall) with segments of the SPI device table. Any device nodes are created later, after the relevant parent SPI controller (bus_num) is defined. We keep this table of devices forever, so that reloading a controller driver will not make Linux forget about these hard-wired devices.h]hX]Board-specific early init code calls this (probably during arch_initcall) with segments of the SPI device table. Any device nodes are created later, after the relevant parent SPI controller (bus_num) is defined. We keep this table of devices forever, so that reloading a controller driver will not make Linux forget about these hard-wired devices.}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMUhjFYubh)}(hOther code can also call this, e.g. a particular add-on board might provide SPI devices through its expansion connector, so code initializing that board would naturally declare its SPI devices.h]hOther code can also call this, e.g. a particular add-on board might provide SPI devices through its expansion connector, so code initializing that board would naturally declare its SPI devices.}(hj+ZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chM[hjFYubh)}(hThe board info passed can safely be __initdata ... but be careful of any embedded pointers (platform_data, etc), they're copied as-is.h]hThe board info passed can safely be __initdata ... but be careful of any embedded pointers (platform_data, etc), they’re copied as-is.}(hj:ZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chM_hjFYubh)}(h **Return**h]j)}(hjKZh]hReturn}(hjMZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjIZubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMbhjFYubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjaZhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:49: ./drivers/spi/spi.chMchjFYubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"__spi_register_driver (C function)c.__spi_register_driverhNtauh1jhhhhhNhNubj)}(hhh](j)}(hIint __spi_register_driver (struct module *owner, struct spi_driver *sdrv)h]j)}(hHint __spi_register_driver(struct module *owner, struct spi_driver *sdrv)h](j4)}(hinth]hint}(hjZhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjZhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZhhhjZhMubj$)}(h__spi_register_driverh]j*)}(h__spi_register_driverh]h__spi_register_driver}(hjZhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjZubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjZhhhjZhMubjl)}(h/(struct module *owner, struct spi_driver *sdrv)h](jr)}(hstruct module *ownerh](j)}(hjh]hstruct}(hjZhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjZubj)}(h h]h }(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubh)}(hhh]j*)}(hmoduleh]hmodule}(hjZhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjZubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjZmodnameN classnameNjj)}j]j)}jjZsbc.__spi_register_driverasbuh1hhjZubj)}(h h]h }(hj [hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubj)}(hjh]h*}(hj[hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZubj*)}(hownerh]howner}(hj&[hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjZubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjZubjr)}(hstruct spi_driver *sdrvh](j)}(hjh]hstruct}(hj?[hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj;[ubj)}(h h]h }(hjL[hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;[ubh)}(hhh]j*)}(h spi_driverh]h spi_driver}(hj][hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjZ[ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj_[modnameN classnameNjj)}j]j[c.__spi_register_driverasbuh1hhj;[ubj)}(h h]h }(hj{[hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;[ubj)}(hjh]h*}(hj[hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj;[ubj*)}(hsdrvh]hsdrv}(hj[hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj;[ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjZubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjZhhhjZhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjZhhhjZhMubah}(h]jZah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjZhMhjZhhubjX)}(hhh]h)}(hregister a SPI driverh]hregister a SPI driver}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[hhubah}(h]h ]h"]h$]h&]uh1jWhjZhhhjZhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj[jzj[j{j|j}uh1jhhhhhNhNubj)}(h**Parameters** ``struct module *owner`` owner module of the driver to register ``struct spi_driver *sdrv`` the driver to register **Context** can sleep **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hj[h]h Parameters}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[ubj)}(hhh](j)}(h@``struct module *owner`` owner module of the driver to register h](j)}(h``struct module *owner``h]h)}(hj\h]hstruct module *owner}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj[ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[ubj)}(hhh]h)}(h&owner module of the driver to registerh]h&owner module of the driver to register}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj\hMhj\ubah}(h]h ]h"]h$]h&]uh1jhj[ubeh}(h]h ]h"]h$]h&]uh1jhj\hMhj[ubj)}(h3``struct spi_driver *sdrv`` the driver to register h](j)}(h``struct spi_driver *sdrv``h]h)}(hj:\h]hstruct spi_driver *sdrv}(hj<\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj8\ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj4\ubj)}(hhh]h)}(hthe driver to registerh]hthe driver to register}(hjS\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjO\hMhjP\ubah}(h]h ]h"]h$]h&]uh1jhj4\ubeh}(h]h ]h"]h$]h&]uh1jhjO\hMhj[ubeh}(h]h ]h"]h$]h&]uh1jhj[ubh)}(h **Context**h]j)}(hju\h]hContext}(hjw\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjs\ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[ubh)}(h can sleeph]h can sleep}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[ubh)}(h **Return**h]j)}(hj\h]hReturn}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj\ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[ubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj[ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_alloc_device (C function)c.spi_alloc_devicehNtauh1jhhhhhNhNubj)}(hhh](j)}(hBstruct spi_device * spi_alloc_device (struct spi_controller *ctlr)h]j)}(h@struct spi_device *spi_alloc_device(struct spi_controller *ctlr)h](j)}(hjh]hstruct}(hj\hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj\hhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hj\hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\hhhj\hMubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hj]hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj\ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj]modnameN classnameNjj)}j]j)}jspi_alloc_devicesbc.spi_alloc_deviceasbuh1hhj\hhhj\hMubj)}(h h]h }(hj!]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\hhhj\hMubj)}(hjh]h*}(hj/]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj\hhhj\hMubj$)}(hspi_alloc_deviceh]j*)}(hj]h]hspi_alloc_device}(hj@]hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj<]ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj\hhhj\hMubjl)}(h(struct spi_controller *ctlr)h]jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hj[]hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjW]ubj)}(h h]h }(hjh]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW]ubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjy]hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjv]ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj{]modnameN classnameNjj)}j]j]c.spi_alloc_deviceasbuh1hhjW]ubj)}(h h]h }(hj]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW]ubj)}(hjh]h*}(hj]hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjW]ubj*)}(hctlrh]hctlr}(hj]hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjW]ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjS]ubah}(h]h ]h"]h$]h&]jAjBuh1jkhj\hhhj\hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj\hhhj\hMubah}(h]j\ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj\hMhj\hhubjX)}(hhh]h)}(hAllocate a new SPI deviceh]hAllocate a new SPI device}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]hhubah}(h]h ]h"]h$]h&]uh1jWhj\hhhj\hMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj]jzj]j{j|j}uh1jhhhhhNhNubj)}(hXg**Parameters** ``struct spi_controller *ctlr`` Controller to which device is connected **Context** can sleep **Description** Allows a driver to allocate and initialize a spi_device without registering it immediately. This allows a driver to directly fill the spi_device with device parameters before calling spi_add_device() on it. Caller is responsible to call spi_add_device() on the returned spi_device structure to add it to the SPI controller. If the caller needs to discard the spi_device without adding it, then it should call spi_dev_put() on it. **Return** a pointer to the new device, or NULL.h](h)}(h**Parameters**h]j)}(hj]h]h Parameters}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj]ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubj)}(hhh]j)}(hH``struct spi_controller *ctlr`` Controller to which device is connected h](j)}(h``struct spi_controller *ctlr``h]h)}(hj^h]hstruct spi_controller *ctlr}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj^ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj^ubj)}(hhh]h)}(h'Controller to which device is connectedh]h'Controller to which device is connected}(hj6^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj2^hMhj3^ubah}(h]h ]h"]h$]h&]uh1jhj^ubeh}(h]h ]h"]h$]h&]uh1jhj2^hMhj^ubah}(h]h ]h"]h$]h&]uh1jhj]ubh)}(h **Context**h]j)}(hjX^h]hContext}(hjZ^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjV^ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubh)}(h can sleeph]h can sleep}(hjn^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubh)}(h**Description**h]j)}(hj^h]h Description}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}^ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubh)}(hAllows a driver to allocate and initialize a spi_device without registering it immediately. This allows a driver to directly fill the spi_device with device parameters before calling spi_add_device() on it.h]hAllows a driver to allocate and initialize a spi_device without registering it immediately. This allows a driver to directly fill the spi_device with device parameters before calling spi_add_device() on it.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubh)}(hCaller is responsible to call spi_add_device() on the returned spi_device structure to add it to the SPI controller. If the caller needs to discard the spi_device without adding it, then it should call spi_dev_put() on it.h]hCaller is responsible to call spi_add_device() on the returned spi_device structure to add it to the SPI controller. If the caller needs to discard the spi_device without adding it, then it should call spi_dev_put() on it.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubh)}(h **Return**h]j)}(hj^h]hReturn}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj^ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubh)}(h%a pointer to the new device, or NULL.h]h%a pointer to the new device, or NULL.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj]ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_add_device (C function)c.spi_add_devicehNtauh1jhhhhhNhNubj)}(hhh](j)}(h+int spi_add_device (struct spi_device *spi)h]j)}(h*int spi_add_device(struct spi_device *spi)h](j4)}(hinth]hint}(hj^hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj^hhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hj _hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj^hhhj_hMubj$)}(hspi_add_deviceh]j*)}(hspi_add_deviceh]hspi_add_device}(hj_hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj_ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj^hhhj_hMubjl)}(h(struct spi_device *spi)h]jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hj7_hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj3_ubj)}(h h]h }(hjD_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3_ubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjU_hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjR_ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjW_modnameN classnameNjj)}j]j)}jj_sbc.spi_add_deviceasbuh1hhj3_ubj)}(h h]h }(hju_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3_ubj)}(hjh]h*}(hj_hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj3_ubj*)}(hspih]hspi}(hj_hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj3_ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj/_ubah}(h]h ]h"]h$]h&]jAjBuh1jkhj^hhhj_hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj^hhhj_hMubah}(h]j^ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj_hMhj^hhubjX)}(hhh]h)}(h.Add spi_device allocated with spi_alloc_deviceh]h.Add spi_device allocated with spi_alloc_device}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_hhubah}(h]h ]h"]h$]h&]uh1jWhj^hhhj_hMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj_jzj_j{j|j}uh1jhhhhhNhNubj)}(hX **Parameters** ``struct spi_device *spi`` spi_device to register **Description** Companion function to spi_alloc_device. Devices allocated with spi_alloc_device can be added onto the SPI bus with this function. **Return** 0 on success; negative errno on failureh](h)}(h**Parameters**h]j)}(hj_h]h Parameters}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj_ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_ubj)}(hhh]j)}(h2``struct spi_device *spi`` spi_device to register h](j)}(h``struct spi_device *spi``h]h)}(hj_h]hstruct spi_device *spi}(hj_hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj_ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_ubj)}(hhh]h)}(hspi_device to registerh]hspi_device to register}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj`hMhj`ubah}(h]h ]h"]h$]h&]uh1jhj_ubeh}(h]h ]h"]h$]h&]uh1jhj`hMhj_ubah}(h]h ]h"]h$]h&]uh1jhj_ubh)}(h**Description**h]j)}(hj6`h]h Description}(hj8`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj4`ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_ubh)}(hCompanion function to spi_alloc_device. Devices allocated with spi_alloc_device can be added onto the SPI bus with this function.h]hCompanion function to spi_alloc_device. Devices allocated with spi_alloc_device can be added onto the SPI bus with this function.}(hjL`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_ubh)}(h **Return**h]j)}(hj]`h]hReturn}(hj_`hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj[`ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_ubh)}(h'0 on success; negative errno on failureh]h'0 on success; negative errno on failure}(hjs`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj_ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_new_device (C function)c.spi_new_devicehNtauh1jhhhhhNhNubj)}(hhh](j)}(h]struct spi_device * spi_new_device (struct spi_controller *ctlr, struct spi_board_info *chip)h]j)}(h[struct spi_device *spi_new_device(struct spi_controller *ctlr, struct spi_board_info *chip)h](j)}(hjh]hstruct}(hj`hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj`hhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`hhhj`hMubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hj`hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj`ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj`modnameN classnameNjj)}j]j)}jspi_new_devicesbc.spi_new_deviceasbuh1hhj`hhhj`hMubj)}(h h]h }(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`hhhj`hMubj)}(hjh]h*}(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj`hhhj`hMubj$)}(hspi_new_deviceh]j*)}(hj`h]hspi_new_device}(hjahhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj`ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj`hhhj`hMubjl)}(h:(struct spi_controller *ctlr, struct spi_board_info *chip)h](jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjahhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjaubj)}(h h]h }(hj)ahhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjaubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hj:ahhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj7aubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjhubj)}(hhh]h)}(h5Pointer to the spi_controller structure of the driverh]h5Pointer to the spi_controller structure of the driver}(hj]hhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjYhhM~hjZhubah}(h]h ]h"]h$]h&]uh1jhj>hubeh}(h]h ]h"]h$]h&]uh1jhjYhhM~hj;hubj)}(hH``struct spi_transfer *xfer`` Pointer to the transfer being timestamped h](j)}(h``struct spi_transfer *xfer``h]h)}(hj}hh]hstruct spi_transfer *xfer}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{hubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjwhubj)}(hhh]h)}(h)Pointer to the transfer being timestampedh]h)Pointer to the transfer being timestamped}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhMhjhubah}(h]h ]h"]h$]h&]uh1jhjwhubeh}(h]h ]h"]h$]h&]uh1jhjhhMhj;hubj)}(hL``size_t progress`` How many words (not bytes) have been transferred so far h](j)}(h``size_t progress``h]h)}(hjhh]hsize_t progress}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhubj)}(hhh]h)}(h7How many words (not bytes) have been transferred so farh]h7How many words (not bytes) have been transferred so far}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhMhjhubah}(h]h ]h"]h$]h&]uh1jhjhubeh}(h]h ]h"]h$]h&]uh1jhjhhMhj;hubj)}(hX[``bool irqs_off`` If true, will disable IRQs and preemption for the duration of the transfer, for less jitter in time measurement. Only compatible with PIO drivers. If true, must follow up with spi_take_timestamp_post or otherwise system will crash. WARNING: for fully predictable results, the CPU frequency must also be under control (governor). h](j)}(h``bool irqs_off``h]h)}(hjhh]h bool irqs_off}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhubj)}(hhh]h)}(hXHIf true, will disable IRQs and preemption for the duration of the transfer, for less jitter in time measurement. Only compatible with PIO drivers. If true, must follow up with spi_take_timestamp_post or otherwise system will crash. WARNING: for fully predictable results, the CPU frequency must also be under control (governor).h]hXHIf true, will disable IRQs and preemption for the duration of the transfer, for less jitter in time measurement. Only compatible with PIO drivers. If true, must follow up with spi_take_timestamp_post or otherwise system will crash. WARNING: for fully predictable results, the CPU frequency must also be under control (governor).}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubah}(h]h ]h"]h$]h&]uh1jhjhubeh}(h]h ]h"]h$]h&]uh1jhjihMhj;hubeh}(h]h ]h"]h$]h&]uh1jhjhubh)}(h**Description**h]j)}(hj+ih]h Description}(hj-ihhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)iubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhubh)}(hXThis is a helper for drivers to collect the beginning of the TX timestamp for the requested byte from the SPI transfer. The frequency with which this function must be called (once per word, once for the whole transfer, once per batch of words etc) is arbitrary as long as the **tx** buffer offset is greater than or equal to the requested byte at the time of the call. The timestamp is only taken once, at the first such call. It is assumed that the driver advances its **tx** buffer pointer monotonically.h](hXThis is a helper for drivers to collect the beginning of the TX timestamp for the requested byte from the SPI transfer. The frequency with which this function must be called (once per word, once for the whole transfer, once per batch of words etc) is arbitrary as long as the }(hjAihhhNhNubj)}(h**tx**h]htx}(hjIihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAiubh buffer offset is greater than or equal to the requested byte at the time of the call. The timestamp is only taken once, at the first such call. It is assumed that the driver advances its }(hjAihhhNhNubj)}(h**tx**h]htx}(hj[ihhhNhNubah}(h]h ]h"]h$]h&]uh1jhjAiubh buffer pointer monotonically.}(hjAihhhNhNubeh}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$spi_take_timestamp_post (C function)c.spi_take_timestamp_posthNtauh1jhhhhhNhNubj)}(hhh](j)}(huvoid spi_take_timestamp_post (struct spi_controller *ctlr, struct spi_transfer *xfer, size_t progress, bool irqs_off)h]j)}(htvoid spi_take_timestamp_post(struct spi_controller *ctlr, struct spi_transfer *xfer, size_t progress, bool irqs_off)h](j4)}(hvoidh]hvoid}(hjihhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjihhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjihhhjihMubj$)}(hspi_take_timestamp_posth]j*)}(hspi_take_timestamp_posth]hspi_take_timestamp_post}(hjihhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjiubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjihhhjihMubjl)}(hX(struct spi_controller *ctlr, struct spi_transfer *xfer, size_t progress, bool irqs_off)h](jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjihhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjiubj)}(h h]h }(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjihhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjiubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjimodnameN classnameNjj)}j]j)}jjisbc.spi_take_timestamp_postasbuh1hhjiubj)}(h h]h }(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubj)}(hjh]h*}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjiubj*)}(hctlrh]hctlr}(hj*jhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjiubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjiubjr)}(hstruct spi_transfer *xferh](j)}(hjh]hstruct}(hjCjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj?jubj)}(h h]h }(hjPjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?jubh)}(hhh]j*)}(h spi_transferh]h spi_transfer}(hjajhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj^jubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjcjmodnameN classnameNjj)}j]j jc.spi_take_timestamp_postasbuh1hhj?jubj)}(h h]h }(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?jubj)}(hjh]h*}(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?jubj*)}(hxferh]hxfer}(hjjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj?jubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjiubjr)}(hsize_t progressh](h)}(hhh]j*)}(hsize_th]hsize_t}(hjjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjjubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjjmodnameN classnameNjj)}j]j jc.spi_take_timestamp_postasbuh1hhjjubj)}(h h]h }(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubj*)}(hprogressh]hprogress}(hjjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjiubjr)}(h bool irqs_offh](j4)}(hjb:h]hbool}(hjjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjjubj)}(h h]h }(hjkhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjjubj*)}(hirqs_offh]hirqs_off}(hjkhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjiubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjihhhjihMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjihhhjihMubah}(h]jiah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjihMhjihhubjX)}(hhh]h)}(h-helper to collect the end of the TX timestamph]h-helper to collect the end of the TX timestamp}(hj@khhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj=khhubah}(h]h ]h"]h$]h&]uh1jWhjihhhjihMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjXkjzjXkj{j|j}uh1jhhhhhNhNubj)}(hXd**Parameters** ``struct spi_controller *ctlr`` Pointer to the spi_controller structure of the driver ``struct spi_transfer *xfer`` Pointer to the transfer being timestamped ``size_t progress`` How many words (not bytes) have been transferred so far ``bool irqs_off`` If true, will re-enable IRQs and preemption for the local CPU. **Description** This is a helper for drivers to collect the end of the TX timestamp for the requested byte from the SPI transfer. Can be called with an arbitrary frequency: only the first call where **tx** exceeds or is equal to the requested word will be timestamped.h](h)}(h**Parameters**h]j)}(hjbkh]h Parameters}(hjdkhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj`kubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj\kubj)}(hhh](j)}(hV``struct spi_controller *ctlr`` Pointer to the spi_controller structure of the driver h](j)}(h``struct spi_controller *ctlr``h]h)}(hjkh]hstruct spi_controller *ctlr}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj{kubj)}(hhh]h)}(h5Pointer to the spi_controller structure of the driverh]h5Pointer to the spi_controller structure of the driver}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhMhjkubah}(h]h ]h"]h$]h&]uh1jhj{kubeh}(h]h ]h"]h$]h&]uh1jhjkhMhjxkubj)}(hH``struct spi_transfer *xfer`` Pointer to the transfer being timestamped h](j)}(h``struct spi_transfer *xfer``h]h)}(hjkh]hstruct spi_transfer *xfer}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjkubj)}(hhh]h)}(h)Pointer to the transfer being timestampedh]h)Pointer to the transfer being timestamped}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkhMhjkubah}(h]h ]h"]h$]h&]uh1jhjkubeh}(h]h ]h"]h$]h&]uh1jhjkhMhjxkubj)}(hL``size_t progress`` How many words (not bytes) have been transferred so far h](j)}(h``size_t progress``h]h)}(hjkh]hsize_t progress}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjkubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjkubj)}(hhh]h)}(h7How many words (not bytes) have been transferred so farh]h7How many words (not bytes) have been transferred so far}(hj lhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjlhMhj lubah}(h]h ]h"]h$]h&]uh1jhjkubeh}(h]h ]h"]h$]h&]uh1jhjlhMhjxkubj)}(hQ``bool irqs_off`` If true, will re-enable IRQs and preemption for the local CPU. h](j)}(h``bool irqs_off``h]h)}(hj,lh]h bool irqs_off}(hj.lhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj*lubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj&lubj)}(hhh]h)}(h>If true, will re-enable IRQs and preemption for the local CPU.h]h>If true, will re-enable IRQs and preemption for the local CPU.}(hjElhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjAlhMhjBlubah}(h]h ]h"]h$]h&]uh1jhj&lubeh}(h]h ]h"]h$]h&]uh1jhjAlhMhjxkubeh}(h]h ]h"]h$]h&]uh1jhj\kubh)}(h**Description**h]j)}(hjglh]h Description}(hjilhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjelubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj\kubh)}(hThis is a helper for drivers to collect the end of the TX timestamp for the requested byte from the SPI transfer. Can be called with an arbitrary frequency: only the first call where **tx** exceeds or is equal to the requested word will be timestamped.h](hThis is a helper for drivers to collect the end of the TX timestamp for the requested byte from the SPI transfer. Can be called with an arbitrary frequency: only the first call where }(hj}lhhhNhNubj)}(h**tx**h]htx}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}lubh? exceeds or is equal to the requested word will be timestamped.}(hj}lhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj\kubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(spi_get_next_queued_message (C function)c.spi_get_next_queued_messagehNtauh1jhhhhhNhNubj)}(hhh](j)}(hNstruct spi_message * spi_get_next_queued_message (struct spi_controller *ctlr)h]j)}(hLstruct spi_message *spi_get_next_queued_message(struct spi_controller *ctlr)h](j)}(hjh]hstruct}(hjlhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjlhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM ubj)}(h h]h }(hjlhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlhhhjlhM ubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hjlhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjlubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjlmodnameN classnameNjj)}j]j)}jspi_get_next_queued_messagesbc.spi_get_next_queued_messageasbuh1hhjlhhhjlhM ubj)}(h h]h }(hjlhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlhhhjlhM ubj)}(hjh]h*}(hj mhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlhhhjlhM ubj$)}(hspi_get_next_queued_messageh]j*)}(hjlh]hspi_get_next_queued_message}(hjmhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjmubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjlhhhjlhM ubjl)}(h(struct spi_controller *ctlr)h]jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hj8mhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj4mubj)}(h h]h }(hjEmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4mubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjVmhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjSmubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjXmmodnameN classnameNjj)}j]jlc.spi_get_next_queued_messageasbuh1hhj4mubj)}(h h]h }(hjtmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4mubj)}(hjh]h*}(hjmhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj4mubj*)}(hctlrh]hctlr}(hjmhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj4mubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj0mubah}(h]h ]h"]h$]h&]jAjBuh1jkhjlhhhjlhM ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjlhhhjlhM ubah}(h]jlah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjlhM hjlhhubjX)}(hhh]h)}(h-called by driver to check for queued messagesh]h-called by driver to check for queued messages}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmhhubah}(h]h ]h"]h$]h&]uh1jWhjlhhhjlhM ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjmjzjmj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_controller *ctlr`` the controller to check for queued messages **Description** If there are more messages in the queue, the next message is returned from this call. **Return** the next message in the queue, else NULL if the queue is empty.h](h)}(h**Parameters**h]j)}(hjmh]h Parameters}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmubj)}(hhh]j)}(hL``struct spi_controller *ctlr`` the controller to check for queued messages h](j)}(h``struct spi_controller *ctlr``h]h)}(hjmh]hstruct spi_controller *ctlr}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjmubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmubj)}(hhh]h)}(h+the controller to check for queued messagesh]h+the controller to check for queued messages}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjnhM hjnubah}(h]h ]h"]h$]h&]uh1jhjmubeh}(h]h ]h"]h$]h&]uh1jhjnhM hjmubah}(h]h ]h"]h$]h&]uh1jhjmubh)}(h**Description**h]j)}(hj5nh]h Description}(hj7nhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj3nubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmubh)}(hUIf there are more messages in the queue, the next message is returned from this call.h]hUIf there are more messages in the queue, the next message is returned from this call.}(hjKnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmubh)}(h **Return**h]j)}(hj\nh]hReturn}(hj^nhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjZnubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmubh)}(h?the next message in the queue, else NULL if the queue is empty.h]h?the next message in the queue, else NULL if the queue is empty.}(hjrnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjmubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)spi_finalize_current_message (C function)c.spi_finalize_current_messagehNtauh1jhhhhhNhNubj)}(hhh](j)}(h?void spi_finalize_current_message (struct spi_controller *ctlr)h]j)}(h>void spi_finalize_current_message(struct spi_controller *ctlr)h](j4)}(hvoidh]hvoid}(hjnhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjnhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMA ubj)}(h h]h }(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnhhhjnhMA ubj$)}(hspi_finalize_current_messageh]j*)}(hspi_finalize_current_messageh]hspi_finalize_current_message}(hjnhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjnubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjnhhhjnhMA ubjl)}(h(struct spi_controller *ctlr)h]jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjnhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjnubj)}(h h]h }(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjnhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjnubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjnmodnameN classnameNjj)}j]j)}jjnsbc.spi_finalize_current_messageasbuh1hhjnubj)}(h h]h }(hjohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubj)}(hjh]h*}(hj*ohhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjnubj*)}(hctlrh]hctlr}(hj7ohhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjnubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjnubah}(h]h ]h"]h$]h&]jAjBuh1jkhjnhhhjnhMA ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjnhhhjnhMA ubah}(h]jnah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjnhMA hjnhhubjX)}(hhh]h)}(hthe current message is completeh]hthe current message is complete}(hjaohhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMA hj^ohhubah}(h]h ]h"]h$]h&]uh1jWhjnhhhjnhMA ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjyojzjyoj{j|j}uh1jhhhhhNhNubj)}(h**Parameters** ``struct spi_controller *ctlr`` the controller to return the message to **Description** Called by the driver to notify the core that the message in the front of the queue is complete and can be removed from the queue.h](h)}(h**Parameters**h]j)}(hjoh]h Parameters}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chME hj}oubj)}(hhh]j)}(hH``struct spi_controller *ctlr`` the controller to return the message to h](j)}(h``struct spi_controller *ctlr``h]h)}(hjoh]hstruct spi_controller *ctlr}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjoubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMB hjoubj)}(hhh]h)}(h'the controller to return the message toh]h'the controller to return the message to}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhjohMB hjoubah}(h]h ]h"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]uh1jhjohMB hjoubah}(h]h ]h"]h$]h&]uh1jhj}oubh)}(h**Description**h]j)}(hjoh]h Description}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1jhjoubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMD hj}oubh)}(hCalled by the driver to notify the core that the message in the front of the queue is complete and can be removed from the queue.h]hCalled by the driver to notify the core that the message in the front of the queue is complete and can be removed from the queue.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMC hj}oubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%spi_new_ancillary_device (C function)c.spi_new_ancillary_devicehNtauh1jhhhhhNhNubj)}(hhh](j)}(hUstruct spi_device * spi_new_ancillary_device (struct spi_device *spi, u8 chip_select)h]j)}(hSstruct spi_device *spi_new_ancillary_device(struct spi_device *spi, u8 chip_select)h](j)}(hjh]hstruct}(hj"phhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjphhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM` ubj)}(h h]h }(hj0phhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjphhhj/phM` ubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjAphhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj>pubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjCpmodnameN classnameNjj)}j]j)}jspi_new_ancillary_devicesbc.spi_new_ancillary_deviceasbuh1hhjphhhj/phM` ubj)}(h h]h }(hjbphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjphhhj/phM` ubj)}(hjh]h*}(hjpphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjphhhj/phM` ubj$)}(hspi_new_ancillary_deviceh]j*)}(hj_ph]hspi_new_ancillary_device}(hjphhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj}pubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjphhhj/phM` ubjl)}(h((struct spi_device *spi, u8 chip_select)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjphhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjpubj)}(h h]h }(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjphhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjpubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjpmodnameN classnameNjj)}j]j]pc.spi_new_ancillary_deviceasbuh1hhjpubj)}(h h]h }(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubj)}(hjh]h*}(hjphhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjpubj*)}(hspih]hspi}(hjphhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjpubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjpubjr)}(hu8 chip_selecth](h)}(hhh]j*)}(hu8h]hu8}(hjqhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj qubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjqmodnameN classnameNjj)}j]j]pc.spi_new_ancillary_deviceasbuh1hhjqubj)}(h h]h }(hj-qhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjqubj*)}(h chip_selecth]h chip_select}(hj;qhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjqubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjpubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjphhhj/phM` ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjphhhj/phM` ubah}(h]jpah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj/phM` hjphhubjX)}(hhh]h)}(hRegister ancillary SPI deviceh]hRegister ancillary SPI device}(hjeqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM` hjbqhhubah}(h]h ]h"]h$]h&]uh1jWhjphhhj/phM` ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj}qjzj}qj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_device *spi`` Pointer to the main SPI device registering the ancillary device ``u8 chip_select`` Chip Select of the ancillary device **Description** Register an ancillary SPI device; for example some chips have a chip-select for normal device usage and another one for setup/firmware upload. This may only be called from main SPI device's probe routine. **Return** the new device on success; an ERR_PTR() on failureh](h)}(h**Parameters**h]j)}(hjqh]h Parameters}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjqubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMd hjqubj)}(hhh](j)}(h[``struct spi_device *spi`` Pointer to the main SPI device registering the ancillary device h](j)}(h``struct spi_device *spi``h]h)}(hjqh]hstruct spi_device *spi}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMa hjqubj)}(hhh]h)}(h?Pointer to the main SPI device registering the ancillary deviceh]h?Pointer to the main SPI device registering the ancillary device}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqhMa hjqubah}(h]h ]h"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]uh1jhjqhMa hjqubj)}(h7``u8 chip_select`` Chip Select of the ancillary device h](j)}(h``u8 chip_select``h]h)}(hjqh]hu8 chip_select}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMb hjqubj)}(hhh]h)}(h#Chip Select of the ancillary deviceh]h#Chip Select of the ancillary device}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjqhMb hjqubah}(h]h ]h"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]uh1jhjqhMb hjqubeh}(h]h ]h"]h$]h&]uh1jhjqubh)}(h**Description**h]j)}(hjrh]h Description}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjrubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMd hjqubh)}(hRegister an ancillary SPI device; for example some chips have a chip-select for normal device usage and another one for setup/firmware upload.h]hRegister an ancillary SPI device; for example some chips have a chip-select for normal device usage and another one for setup/firmware upload.}(hj0rhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMc hjqubh)}(h=This may only be called from main SPI device's probe routine.h]h?This may only be called from main SPI device’s probe routine.}(hj?rhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMf hjqubh)}(h **Return**h]j)}(hjPrh]hReturn}(hjRrhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjNrubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMh hjqubh)}(h2the new device on success; an ERR_PTR() on failureh]h2the new device on success; an ERR_PTR() on failure}(hjfrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMi hjqubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j*devm_spi_new_ancillary_device (C function)c.devm_spi_new_ancillary_devicehNtauh1jhhhhhNhNubj)}(hhh](j)}(hZstruct spi_device * devm_spi_new_ancillary_device (struct spi_device *spi, u8 chip_select)h]j)}(hXstruct spi_device *devm_spi_new_ancillary_device(struct spi_device *spi, u8 chip_select)h](j)}(hjh]hstruct}(hjrhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjrhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM ubj)}(h h]h }(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrhhhjrhM ubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjrhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjrubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjrmodnameN classnameNjj)}j]j)}jdevm_spi_new_ancillary_devicesbc.devm_spi_new_ancillary_deviceasbuh1hhjrhhhjrhM ubj)}(h h]h }(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrhhhjrhM ubj)}(hjh]h*}(hjrhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjrhhhjrhM ubj$)}(hdevm_spi_new_ancillary_deviceh]j*)}(hjrh]hdevm_spi_new_ancillary_device}(hjrhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjrubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjrhhhjrhM ubjl)}(h((struct spi_device *spi, u8 chip_select)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjshhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj subj)}(h h]h }(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj subh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hj-shhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj*subah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj/smodnameN classnameNjj)}j]jrc.devm_spi_new_ancillary_deviceasbuh1hhj subj)}(h h]h }(hjKshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj subj)}(hjh]h*}(hjYshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj subj*)}(hspih]hspi}(hjfshhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj subeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjsubjr)}(hu8 chip_selecth](h)}(hhh]j*)}(hu8h]hu8}(hjshhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjsubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjsmodnameN classnameNjj)}j]jrc.devm_spi_new_ancillary_deviceasbuh1hhj{subj)}(h h]h }(hjshhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{subj*)}(h chip_selecth]h chip_select}(hjshhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj{subeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjsubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjrhhhjrhM ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjrhhhjrhM ubah}(h]jrah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjrhM hjrhhubjX)}(hhh]h)}(h%Register managed ancillary SPI deviceh]h%Register managed ancillary SPI device}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjshhubah}(h]h ]h"]h$]h&]uh1jWhjrhhhjrhM ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjsjzjsj{j|j}uh1jhhhhhNhNubj)}(hXr**Parameters** ``struct spi_device *spi`` Pointer to the main SPI device registering the ancillary device ``u8 chip_select`` Chip Select of the ancillary device **Description** Register an ancillary SPI device; for example some chips have a chip-select for normal device usage and another one for setup/firmware upload. This is the managed version of spi_new_ancillary_device(). The ancillary device will be unregistered automatically when the parent SPI device is unregistered. This may only be called from main SPI device's probe routine. **Return** Pointer to new ancillary device on success; ERR_PTR on failureh](h)}(h**Parameters**h]j)}(hjsh]h Parameters}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1jhjsubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubj)}(hhh](j)}(h[``struct spi_device *spi`` Pointer to the main SPI device registering the ancillary device h](j)}(h``struct spi_device *spi``h]h)}(hjth]hstruct spi_device *spi}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjtubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjtubj)}(hhh]h)}(h?Pointer to the main SPI device registering the ancillary deviceh]h?Pointer to the main SPI device registering the ancillary device}(hj2thhhNhNubah}(h]h ]h"]h$]h&]uh1hhj.thM hj/tubah}(h]h ]h"]h$]h&]uh1jhjtubeh}(h]h ]h"]h$]h&]uh1jhj.thM hjtubj)}(h7``u8 chip_select`` Chip Select of the ancillary device h](j)}(h``u8 chip_select``h]h)}(hjRth]hu8 chip_select}(hjTthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjPtubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjLtubj)}(hhh]h)}(h#Chip Select of the ancillary deviceh]h#Chip Select of the ancillary device}(hjkthhhNhNubah}(h]h ]h"]h$]h&]uh1hhjgthM hjhtubah}(h]h ]h"]h$]h&]uh1jhjLtubeh}(h]h ]h"]h$]h&]uh1jhjgthM hjtubeh}(h]h ]h"]h$]h&]uh1jhjsubh)}(h**Description**h]j)}(hjth]h Description}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubh)}(hRegister an ancillary SPI device; for example some chips have a chip-select for normal device usage and another one for setup/firmware upload.h]hRegister an ancillary SPI device; for example some chips have a chip-select for normal device usage and another one for setup/firmware upload.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubh)}(hThis is the managed version of spi_new_ancillary_device(). The ancillary device will be unregistered automatically when the parent SPI device is unregistered.h]hThis is the managed version of spi_new_ancillary_device(). The ancillary device will be unregistered automatically when the parent SPI device is unregistered.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubh)}(h=This may only be called from main SPI device's probe routine.h]h?This may only be called from main SPI device’s probe routine.}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubh)}(h **Return**h]j)}(hjth]hReturn}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjtubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubh)}(h>Pointer to new ancillary device on success; ERR_PTR on failureh]h>Pointer to new ancillary device on success; ERR_PTR on failure}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjsubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j%acpi_spi_count_resources (C function)c.acpi_spi_count_resourceshNtauh1jhhhhhNhNubj)}(hhh](j)}(h7int acpi_spi_count_resources (struct acpi_device *adev)h]j)}(h6int acpi_spi_count_resources(struct acpi_device *adev)h](j4)}(hinth]hint}(hjuhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjuhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM ubj)}(h h]h }(hj&uhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjuhhhj%uhM ubj$)}(hacpi_spi_count_resourcesh]j*)}(hacpi_spi_count_resourcesh]hacpi_spi_count_resources}(hj8uhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj4uubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjuhhhj%uhM ubjl)}(h(struct acpi_device *adev)h]jr)}(hstruct acpi_device *adevh](j)}(hjh]hstruct}(hjTuhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjPuubj)}(h h]h }(hjauhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPuubh)}(hhh]j*)}(h acpi_deviceh]h acpi_device}(hjruhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjouubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjtumodnameN classnameNjj)}j]j)}jj:usbc.acpi_spi_count_resourcesasbuh1hhjPuubj)}(h h]h }(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPuubj)}(hjh]h*}(hjuhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjPuubj*)}(hadevh]hadev}(hjuhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjPuubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjLuubah}(h]h ]h"]h$]h&]jAjBuh1jkhjuhhhj%uhM ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjuhhhj%uhM ubah}(h]j uah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj%uhM hj uhhubjX)}(hhh]h)}(h*Count the number of SpiSerialBus resourcesh]h*Count the number of SpiSerialBus resources}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjuhhubah}(h]h ]h"]h$]h&]uh1jWhj uhhhj%uhM ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjujzjuj{j|j}uh1jhhhhhNhNubj)}(h**Parameters** ``struct acpi_device *adev`` ACPI device **Return** the number of SpiSerialBus resources in the ACPI-device's resource-list; or a negative error code.h](h)}(h**Parameters**h]j)}(hjuh]h Parameters}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjuubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjuubj)}(hhh]j)}(h)``struct acpi_device *adev`` ACPI device h](j)}(h``struct acpi_device *adev``h]h)}(hjvh]hstruct acpi_device *adev}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjvubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjvubj)}(hhh]h)}(h ACPI deviceh]h ACPI device}(hj1vhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-vhM hj.vubah}(h]h ]h"]h$]h&]uh1jhjvubeh}(h]h ]h"]h$]h&]uh1jhj-vhM hjvubah}(h]h ]h"]h$]h&]uh1jhjuubh)}(h **Return**h]j)}(hjSvh]hReturn}(hjUvhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjQvubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjuubh)}(hbthe number of SpiSerialBus resources in the ACPI-device's resource-list; or a negative error code.h]hdthe number of SpiSerialBus resources in the ACPI-device’s resource-list; or a negative error code.}(hjivhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjuubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j"acpi_spi_device_alloc (C function)c.acpi_spi_device_allochNtauh1jhhhhhNhNubj)}(hhh](j)}(hlstruct spi_device * acpi_spi_device_alloc (struct spi_controller *ctlr, struct acpi_device *adev, int index)h]j)}(hjstruct spi_device *acpi_spi_device_alloc(struct spi_controller *ctlr, struct acpi_device *adev, int index)h](j)}(hjh]hstruct}(hjvhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjvhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMh ubj)}(h h]h }(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvhhhjvhMh ubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjvhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjvubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjvmodnameN classnameNjj)}j]j)}jacpi_spi_device_allocsbc.acpi_spi_device_allocasbuh1hhjvhhhjvhMh ubj)}(h h]h }(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvhhhjvhMh ubj)}(hjh]h*}(hjvhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvhhhjvhMh ubj$)}(hacpi_spi_device_alloch]j*)}(hjvh]hacpi_spi_device_alloc}(hjvhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjvubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjvhhhjvhMh ubjl)}(hB(struct spi_controller *ctlr, struct acpi_device *adev, int index)h](jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjwhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjwubj)}(h h]h }(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hj0whhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj-wubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj2wmodnameN classnameNjj)}j]jvc.acpi_spi_device_allocasbuh1hhjwubj)}(h h]h }(hjNwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwubj)}(hjh]h*}(hj\whhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwubj*)}(hctlrh]hctlr}(hjiwhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjwubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj wubjr)}(hstruct acpi_device *adevh](j)}(hjh]hstruct}(hjwhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj~wubj)}(h h]h }(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~wubh)}(hhh]j*)}(h acpi_deviceh]h acpi_device}(hjwhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjwubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjwmodnameN classnameNjj)}j]jvc.acpi_spi_device_allocasbuh1hhj~wubj)}(h h]h }(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~wubj)}(hjh]h*}(hjwhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~wubj*)}(hadevh]hadev}(hjwhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj~wubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj wubjr)}(h int indexh](j4)}(hinth]hint}(hjwhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjwubj)}(h h]h }(hjxhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjwubj*)}(hindexh]hindex}(hjxhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjwubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj wubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjvhhhjvhMh ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjvhhhjvhMh ubah}(h]jvah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjvhMh hjvhhubjX)}(hhh]h)}(h;Allocate a spi device, and fill it in with ACPI informationh]h;Allocate a spi device, and fill it in with ACPI information}(hj8xhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMh hj5xhhubah}(h]h ]h"]h$]h&]uh1jWhjvhhhjvhMh ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjPxjzjPxj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_controller *ctlr`` controller to which the spi device belongs ``struct acpi_device *adev`` ACPI Device for the spi device ``int index`` Index of the spi resource inside the ACPI Node **Description** This should be used to allocate a new SPI device from and ACPI Device node. The caller is responsible for calling spi_add_device to register the SPI device. If ctlr is set to NULL, the Controller for the SPI device will be looked up using the resource. If index is set to -1, index is not used. **Note** If index is -1, ctlr must be set. **Return** a pointer to the new device, or ERR_PTR on error.h](h)}(h**Parameters**h]j)}(hjZxh]h Parameters}(hj\xhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXxubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMl hjTxubj)}(hhh](j)}(hK``struct spi_controller *ctlr`` controller to which the spi device belongs h](j)}(h``struct spi_controller *ctlr``h]h)}(hjyxh]hstruct spi_controller *ctlr}(hj{xhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwxubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMi hjsxubj)}(hhh]h)}(h*controller to which the spi device belongsh]h*controller to which the spi device belongs}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjxhMi hjxubah}(h]h ]h"]h$]h&]uh1jhjsxubeh}(h]h ]h"]h$]h&]uh1jhjxhMi hjpxubj)}(h<``struct acpi_device *adev`` ACPI Device for the spi device h](j)}(h``struct acpi_device *adev``h]h)}(hjxh]hstruct acpi_device *adev}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjxubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMj hjxubj)}(hhh]h)}(hACPI Device for the spi deviceh]hACPI Device for the spi device}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjxhMj hjxubah}(h]h ]h"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]uh1jhjxhMj hjpxubj)}(h=``int index`` Index of the spi resource inside the ACPI Node h](j)}(h ``int index``h]h)}(hjxh]h int index}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjxubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMk hjxubj)}(hhh]h)}(h.Index of the spi resource inside the ACPI Nodeh]h.Index of the spi resource inside the ACPI Node}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjyhMk hjyubah}(h]h ]h"]h$]h&]uh1jhjxubeh}(h]h ]h"]h$]h&]uh1jhjyhMk hjpxubeh}(h]h ]h"]h$]h&]uh1jhjTxubh)}(h**Description**h]j)}(hj&yh]h Description}(hj(yhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$yubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMm hjTxubh)}(hThis should be used to allocate a new SPI device from and ACPI Device node. The caller is responsible for calling spi_add_device to register the SPI device.h]hThis should be used to allocate a new SPI device from and ACPI Device node. The caller is responsible for calling spi_add_device to register the SPI device.}(hjabort the ongoing transfer request on an SPI target controllerh]h>abort the ongoing transfer request on an SPI target controller}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM" hjzhhubah}(h]h ]h"]h$]h&]uh1jWhjyhhhjyhM" ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjzjzjzj{j|j}uh1jhhhhhNhNubj)}(hQ**Parameters** ``struct spi_device *spi`` device used for the current transferh](h)}(h**Parameters**h]j)}(hjzh]h Parameters}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM& hjzubj)}(hhh]j)}(h?``struct spi_device *spi`` device used for the current transferh](j)}(h``struct spi_device *spi``h]h)}(hjzh]hstruct spi_device *spi}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjzubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM( hjzubj)}(hhh]h)}(h$device used for the current transferh]h$device used for the current transfer}(hjzhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM# hjzubah}(h]h ]h"]h$]h&]uh1jhjzubeh}(h]h ]h"]h$]h&]uh1jhjzhM( hjzubah}(h]h ]h"]h$]h&]uh1jhjzubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#__spi_alloc_controller (C function)c.__spi_alloc_controllerhNtauh1jhhhhhNhNubj)}(hhh](j)}(hcstruct spi_controller * __spi_alloc_controller (struct device *dev, unsigned int size, bool target)h]j)}(hastruct spi_controller *__spi_alloc_controller(struct device *dev, unsigned int size, bool target)h](j)}(hjh]hstruct}(hj#{hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj{hhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM ubj)}(h h]h }(hj1{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{hhhj0{hM ubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjB{hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj?{ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjD{modnameN classnameNjj)}j]j)}j__spi_alloc_controllersbc.__spi_alloc_controllerasbuh1hhj{hhhj0{hM ubj)}(h h]h }(hjc{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{hhhj0{hM ubj)}(hjh]h*}(hjq{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{hhhj0{hM ubj$)}(h__spi_alloc_controllerh]j*)}(hj`{h]h__spi_alloc_controller}(hj{hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj~{ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hj{hhhj0{hM ubjl)}(h4(struct device *dev, unsigned int size, bool target)h](jr)}(hstruct device *devh](j)}(hjh]hstruct}(hj{hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj{ubj)}(h h]h }(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubh)}(hhh]j*)}(hdeviceh]hdevice}(hj{hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj{ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj{modnameN classnameNjj)}j]j^{c.__spi_alloc_controllerasbuh1hhj{ubj)}(h h]h }(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj)}(hjh]h*}(hj{hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj{ubj*)}(hdevh]hdev}(hj{hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj{ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj{ubjr)}(hunsigned int sizeh](j4)}(hunsignedh]hunsigned}(hj |hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj |ubj)}(h h]h }(hj|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj |ubj4)}(hinth]hint}(hj)|hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj |ubj)}(h h]h }(hj7|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj |ubj*)}(hsizeh]hsize}(hjE|hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj |ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj{ubjr)}(h bool targeth](j4)}(hjb:h]hbool}(hj^|hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjZ|ubj)}(h h]h }(hjk|hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjZ|ubj*)}(htargeth]htarget}(hjy|hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjZ|ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj{ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhj{hhhj0{hM ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhj{hhhj0{hM ubah}(h]j{ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj0{hM hj{hhubjX)}(hhh]h)}(h)allocate an SPI host or target controllerh]h)allocate an SPI host or target controller}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|hhubah}(h]h ]h"]h$]h&]uh1jWhj{hhhj0{hM ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj|jzj|j{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct device *dev`` the controller, possibly using the platform_bus ``unsigned int size`` how much zeroed driver-private data to allocate; the pointer to this memory is in the driver_data field of the returned device, accessible with spi_controller_get_devdata(); the memory is cacheline aligned; drivers granting DMA access to portions of their private data need to round up **size** using ALIGN(size, dma_get_cache_alignment()). ``bool target`` flag indicating whether to allocate an SPI host (false) or SPI target (true) controller **Context** can sleep **Description** This call is used only by SPI controller drivers, which are the only ones directly touching chip registers. It's how they allocate an spi_controller structure, prior to calling spi_register_controller(). This must be called from context that can sleep. The caller is responsible for assigning the bus number and initializing the controller's methods before calling spi_register_controller(); and calling spi_controller_put() to prevent a memory leak when done with the controller. **Return** the SPI controller structure on success, else NULL.h](h)}(h**Parameters**h]j)}(hj|h]h Parameters}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj|ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubj)}(hhh](j)}(hG``struct device *dev`` the controller, possibly using the platform_bus h](j)}(h``struct device *dev``h]h)}(hj|h]hstruct device *dev}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubj)}(hhh]h)}(h/the controller, possibly using the platform_bush]h/the controller, possibly using the platform_bus}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj|hM hj|ubah}(h]h ]h"]h$]h&]uh1jhj|ubeh}(h]h ]h"]h$]h&]uh1jhj|hM hj|ubj)}(hXk``unsigned int size`` how much zeroed driver-private data to allocate; the pointer to this memory is in the driver_data field of the returned device, accessible with spi_controller_get_devdata(); the memory is cacheline aligned; drivers granting DMA access to portions of their private data need to round up **size** using ALIGN(size, dma_get_cache_alignment()). h](j)}(h``unsigned int size``h]h)}(hj}h]hunsigned int size}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj}ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj}ubj)}(hhh]h)}(hXThow much zeroed driver-private data to allocate; the pointer to this memory is in the driver_data field of the returned device, accessible with spi_controller_get_devdata(); the memory is cacheline aligned; drivers granting DMA access to portions of their private data need to round up **size** using ALIGN(size, dma_get_cache_alignment()).h](hXhow much zeroed driver-private data to allocate; the pointer to this memory is in the driver_data field of the returned device, accessible with spi_controller_get_devdata(); the memory is cacheline aligned; drivers granting DMA access to portions of their private data need to round up }(hj6}hhhNhNubj)}(h**size**h]hsize}(hj>}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj6}ubh. using ALIGN(size, dma_get_cache_alignment()).}(hj6}hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj3}ubah}(h]h ]h"]h$]h&]uh1jhj}ubeh}(h]h ]h"]h$]h&]uh1jhj2}hM hj|ubj)}(hh``bool target`` flag indicating whether to allocate an SPI host (false) or SPI target (true) controller h](j)}(h``bool target``h]h)}(hji}h]h bool target}(hjk}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjg}ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjc}ubj)}(hhh]h)}(hWflag indicating whether to allocate an SPI host (false) or SPI target (true) controllerh]hWflag indicating whether to allocate an SPI host (false) or SPI target (true) controller}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj}ubah}(h]h ]h"]h$]h&]uh1jhjc}ubeh}(h]h ]h"]h$]h&]uh1jhj~}hM hj|ubeh}(h]h ]h"]h$]h&]uh1jhj|ubh)}(h **Context**h]j)}(hj}h]hContext}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(h can sleeph]h can sleep}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(h**Description**h]j)}(hj}h]h Description}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj}ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(hThis call is used only by SPI controller drivers, which are the only ones directly touching chip registers. It's how they allocate an spi_controller structure, prior to calling spi_register_controller().h]hThis call is used only by SPI controller drivers, which are the only ones directly touching chip registers. It’s how they allocate an spi_controller structure, prior to calling spi_register_controller().}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(h0This must be called from context that can sleep.h]h0This must be called from context that can sleep.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(hThe caller is responsible for assigning the bus number and initializing the controller's methods before calling spi_register_controller(); and calling spi_controller_put() to prevent a memory leak when done with the controller.h]hThe caller is responsible for assigning the bus number and initializing the controller’s methods before calling spi_register_controller(); and calling spi_controller_put() to prevent a memory leak when done with the controller.}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(h **Return**h]j)}(hj~h]hReturn}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj~ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubh)}(h3the SPI controller structure on success, else NULL.h]h3the SPI controller structure on success, else NULL.}(hj'~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj|ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j(__devm_spi_alloc_controller (C function)c.__devm_spi_alloc_controllerhNtauh1jhhhhhNhNubj)}(hhh](j)}(hhstruct spi_controller * __devm_spi_alloc_controller (struct device *dev, unsigned int size, bool target)h]j)}(hfstruct spi_controller *__devm_spi_alloc_controller(struct device *dev, unsigned int size, bool target)h](j)}(hjh]hstruct}(hjV~hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjR~hhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM ubj)}(h h]h }(hjd~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjR~hhhjc~hM ubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hju~hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjr~ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjw~modnameN classnameNjj)}j]j)}j__devm_spi_alloc_controllersbc.__devm_spi_alloc_controllerasbuh1hhjR~hhhjc~hM ubj)}(h h]h }(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjR~hhhjc~hM ubj)}(hjh]h*}(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjR~hhhjc~hM ubj$)}(h__devm_spi_alloc_controllerh]j*)}(hj~h]h__devm_spi_alloc_controller}(hj~hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj~ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjR~hhhjc~hM ubjl)}(h4(struct device *dev, unsigned int size, bool target)h](jr)}(hstruct device *devh](j)}(hjh]hstruct}(hj~hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj~ubj)}(h h]h }(hj~hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~ubh)}(hhh]j*)}(hdeviceh]hdevice}(hj~hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj~ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj~modnameN classnameNjj)}j]j~c.__devm_spi_alloc_controllerasbuh1hhj~ubj)}(h h]h }(hj hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~ubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj~ubj*)}(hdevh]hdev}(hj'hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj~ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubjr)}(hunsigned int sizeh](j4)}(hunsignedh]hunsigned}(hj@hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj<ubj)}(h h]h }(hjNhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<ubj4)}(hinth]hint}(hj\hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hj<ubj)}(h h]h }(hjjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj<ubj*)}(hsizeh]hsize}(hjxhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj<ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubjr)}(h bool targeth](j4)}(hjb:h]hbool}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(htargeth]htarget}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjR~hhhjc~hM ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjN~hhhjc~hM ubah}(h]jI~ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjc~hM hjK~hhubjX)}(hhh]h)}(h)resource-managed __spi_alloc_controller()h]h)resource-managed __spi_alloc_controller()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjhhubah}(h]h ]h"]h$]h&]uh1jWhjK~hhhjc~hM ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhNhNubj)}(hXY**Parameters** ``struct device *dev`` physical device of SPI controller ``unsigned int size`` how much zeroed driver-private data to allocate ``bool target`` whether to allocate an SPI host (false) or SPI target (true) controller **Context** can sleep **Description** Allocate an SPI controller and automatically release a reference on it when **dev** is unbound from its driver. Drivers are thus relieved from having to call spi_controller_put(). The arguments to this function are identical to __spi_alloc_controller(). **Return** the SPI controller structure on success, else NULL.h](h)}(h**Parameters**h]j)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubj)}(hhh](j)}(h9``struct device *dev`` physical device of SPI controller h](j)}(h``struct device *dev``h]h)}(hjh]hstruct device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubj)}(hhh]h)}(h!physical device of SPI controllerh]h!physical device of SPI controller}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj,hM hj-ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj,hM hjubj)}(hF``unsigned int size`` how much zeroed driver-private data to allocate h](j)}(h``unsigned int size``h]h)}(hjPh]hunsigned int size}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjNubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjJubj)}(hhh]h)}(h/how much zeroed driver-private data to allocateh]h/how much zeroed driver-private data to allocate}(hjihhhNhNubah}(h]h ]h"]h$]h&]uh1hhjehM hjfubah}(h]h ]h"]h$]h&]uh1jhjJubeh}(h]h ]h"]h$]h&]uh1jhjehM hjubj)}(hX``bool target`` whether to allocate an SPI host (false) or SPI target (true) controller h](j)}(h``bool target``h]h)}(hjh]h bool target}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubj)}(hhh]h)}(hGwhether to allocate an SPI host (false) or SPI target (true) controllerh]hGwhether to allocate an SPI host (false) or SPI target (true) controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM hjubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Context**h]j)}(hjĀh]hContext}(hjƀhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj€ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h can sleeph]h can sleep}(hjڀhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(hAllocate an SPI controller and automatically release a reference on it when **dev** is unbound from its driver. Drivers are thus relieved from having to call spi_controller_put().h](hLAllocate an SPI controller and automatically release a reference on it when }(hjhhhNhNubj)}(h**dev**h]hdev}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubha is unbound from its driver. Drivers are thus relieved from having to call spi_controller_put().}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(hIThe arguments to this function are identical to __spi_alloc_controller().h]hIThe arguments to this function are identical to __spi_alloc_controller().}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h **Return**h]j)}(hj3h]hReturn}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj1ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h3the SPI controller structure on success, else NULL.h]h3the SPI controller structure on success, else NULL.}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j$spi_register_controller (C function)c.spi_register_controllerhNtauh1jhhhhhNhNubj)}(hhh](j)}(h9int spi_register_controller (struct spi_controller *ctlr)h]j)}(h8int spi_register_controller(struct spi_controller *ctlr)h](j4)}(hinth]hint}(hjxhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjthhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM\ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjthhhjhM\ubj$)}(hspi_register_controllerh]j*)}(hspi_register_controllerh]hspi_register_controller}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjthhhjhM\ubjl)}(h(struct spi_controller *ctlr)h]jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjӁhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjЁubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjՁmodnameN classnameNjj)}j]j)}jjsbc.spi_register_controllerasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hctlrh]hctlr}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubah}(h]h ]h"]h$]h&]jAjBuh1jkhjthhhjhM\ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjphhhjhM\ubah}(h]jkah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhM\hjmhhubjX)}(hhh]h)}(h®ister SPI host or target controllerh]h®ister SPI host or target controller}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM\hj5hhubah}(h]h ]h"]h$]h&]uh1jWhjmhhhjhM\ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjPjzjPj{j|j}uh1jhhhhhNhNubj)}(hXy**Parameters** ``struct spi_controller *ctlr`` initialized controller, originally from spi_alloc_host() or spi_alloc_target() **Context** can sleep **Description** SPI controllers connect to their drivers using some non-SPI bus, such as the platform bus. The final stage of probe() in that code includes calling spi_register_controller() to hook up to this SPI bus glue. SPI controllers use board specific (often SOC specific) bus numbers, and board-specific addressing for SPI devices combines those numbers with chip select numbers. Since SPI does not directly support dynamic device identification, boards need configuration tables telling which chip is at which address. This must be called from context that can sleep. After a successful return, the caller is responsible for calling spi_unregister_controller(). **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjZh]h Parameters}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjXubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM`hjTubj)}(hhh]j)}(ho``struct spi_controller *ctlr`` initialized controller, originally from spi_alloc_host() or spi_alloc_target() h](j)}(h``struct spi_controller *ctlr``h]h)}(hjyh]hstruct spi_controller *ctlr}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjwubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM^hjsubj)}(hhh]h)}(hNinitialized controller, originally from spi_alloc_host() or spi_alloc_target()h]hNinitialized controller, originally from spi_alloc_host() or spi_alloc_target()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM]hjubah}(h]h ]h"]h$]h&]uh1jhjsubeh}(h]h ]h"]h$]h&]uh1jhjhM^hjpubah}(h]h ]h"]h$]h&]uh1jhjTubh)}(h **Context**h]j)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM`hjTubh)}(h can sleeph]h can sleep}(hj˂hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM_hjTubh)}(h**Description**h]j)}(hj܂h]h Description}(hjނhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjڂubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMahjTubh)}(hSPI controllers connect to their drivers using some non-SPI bus, such as the platform bus. The final stage of probe() in that code includes calling spi_register_controller() to hook up to this SPI bus glue.h]hSPI controllers connect to their drivers using some non-SPI bus, such as the platform bus. The final stage of probe() in that code includes calling spi_register_controller() to hook up to this SPI bus glue.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM`hjTubh)}(hX0SPI controllers use board specific (often SOC specific) bus numbers, and board-specific addressing for SPI devices combines those numbers with chip select numbers. Since SPI does not directly support dynamic device identification, boards need configuration tables telling which chip is at which address.h]hX0SPI controllers use board specific (often SOC specific) bus numbers, and board-specific addressing for SPI devices combines those numbers with chip select numbers. Since SPI does not directly support dynamic device identification, boards need configuration tables telling which chip is at which address.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMdhjTubh)}(h0This must be called from context that can sleep.h]h0This must be called from context that can sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMjhjTubh)}(h]After a successful return, the caller is responsible for calling spi_unregister_controller().h]h]After a successful return, the caller is responsible for calling spi_unregister_controller().}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMlhjTubh)}(h **Return**h]j)}(hj0h]hReturn}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj.ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMohjTubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMphjTubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j)devm_spi_register_controller (C function)c.devm_spi_register_controllerhNtauh1jhhhhhNhNubj)}(hhh](j)}(hRint devm_spi_register_controller (struct device *dev, struct spi_controller *ctlr)h]j)}(hQint devm_spi_register_controller(struct device *dev, struct spi_controller *ctlr)h](j4)}(hinth]hint}(hjuhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjqhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjqhhhjhMubj$)}(hdevm_spi_register_controllerh]j*)}(hdevm_spi_register_controllerh]hdevm_spi_register_controller}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjqhhhjhMubjl)}(h1(struct device *dev, struct spi_controller *ctlr)h](jr)}(hstruct device *devh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(hdeviceh]hdevice}(hjЃhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj̓ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj҃modnameN classnameNjj)}j]j)}jjsbc.devm_spi_register_controllerasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hdevh]hdev}(hj hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubjr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hj$hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj ubj)}(h h]h }(hj1hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjBhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj?ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjDmodnameN classnameNjj)}j]jc.devm_spi_register_controllerasbuh1hhj ubj)}(h h]h }(hj`hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj)}(hjh]h*}(hjnhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj ubj*)}(hctlrh]hctlr}(hj{hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjqhhhjhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjmhhhjhMubah}(h]jhah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjjhhubjX)}(hhh]h)}(h.register managed SPI host or target controllerh]h.register managed SPI host or target controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhhubah}(h]h ]h"]h$]h&]uh1jWhjjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct device *dev`` device managing SPI controller ``struct spi_controller *ctlr`` initialized controller, originally from spi_alloc_host() or spi_alloc_target() **Context** can sleep **Description** Register a SPI device as with spi_register_controller() which will automatically be unregistered. **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjDŽh]h Parameters}(hjɄhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjńubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh](j)}(h6``struct device *dev`` device managing SPI controller h](j)}(h``struct device *dev``h]h)}(hjh]hstruct device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hdevice managing SPI controllerh]hdevice managing SPI controller}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhj݄ubj)}(ho``struct spi_controller *ctlr`` initialized controller, originally from spi_alloc_host() or spi_alloc_target() h](j)}(h``struct spi_controller *ctlr``h]h)}(hjh]hstruct spi_controller *ctlr}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hNinitialized controller, originally from spi_alloc_host() or spi_alloc_target()h]hNinitialized controller, originally from spi_alloc_host() or spi_alloc_target()}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj5ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj4hMhj݄ubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Context**h]j)}(hj[h]hContext}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjYubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h can sleeph]h can sleep}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(haRegister a SPI device as with spi_register_controller() which will automatically be unregistered.h]haRegister a SPI device as with spi_register_controller() which will automatically be unregistered.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h **Return**h]j)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&spi_unregister_controller (C function)c.spi_unregister_controllerhNtauh1jhhhhhNhNubj)}(hhh](j)}(hmodnameN classnameNjj)}j]jc.spi_optimize_messageasbuh1hhjubj)}(h h]h }(hjZhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hmsgh]hmsg}(hjuhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjkhhhj}hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjghhhj}hMubah}(h]jbah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj}hMhjdhhubjX)}(hhh]h)}(h6do any one-time validation and setup for a SPI messageh]h6do any one-time validation and setup for a SPI message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhhubah}(h]h ]h"]h$]h&]uh1jWhjdhhhj}hMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhNhNubj)}(hX **Parameters** ``struct spi_device *spi`` the device that will be used for the message ``struct spi_message *msg`` the message to optimize **Description** Peripheral drivers that reuse the same message repeatedly may call this to perform as much message prep as possible once, rather than repeating it each time a message transfer is performed to improve throughput and reduce CPU usage. Once a message has been optimized, it cannot be modified with the exception of updating the contents of any xfer->tx_buf (the pointer can't be changed, only the data in the memory it points to). Calls to this function must be balanced with calls to spi_unoptimize_message() to avoid leaking resources. **Context** can sleep **Return** zero on success, else a negative error codeh](h)}(h**Parameters**h]j)}(hjh]h Parameters}(hjÐhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh](j)}(hH``struct spi_device *spi`` the device that will be used for the message h](j)}(h``struct spi_device *spi``h]h)}(hjh]hstruct spi_device *spi}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjސubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjڐubj)}(hhh]h)}(h,the device that will be used for the messageh]h,the device that will be used for the message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjڐubeh}(h]h ]h"]h$]h&]uh1jhjhMhjאubj)}(h4``struct spi_message *msg`` the message to optimize h](j)}(h``struct spi_message *msg``h]h)}(hjh]hstruct spi_message *msg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hthe message to optimizeh]hthe message to optimize}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj.hMhj/ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj.hMhjאubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]j)}(hjTh]h Description}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjRubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hPeripheral drivers that reuse the same message repeatedly may call this to perform as much message prep as possible once, rather than repeating it each time a message transfer is performed to improve throughput and reduce CPU usage.h]hPeripheral drivers that reuse the same message repeatedly may call this to perform as much message prep as possible once, rather than repeating it each time a message transfer is performed to improve throughput and reduce CPU usage.}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hOnce a message has been optimized, it cannot be modified with the exception of updating the contents of any xfer->tx_buf (the pointer can't be changed, only the data in the memory it points to).h]hOnce a message has been optimized, it cannot be modified with the exception of updating the contents of any xfer->tx_buf (the pointer can’t be changed, only the data in the memory it points to).}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hjCalls to this function must be balanced with calls to spi_unoptimize_message() to avoid leaking resources.h]hjCalls to this function must be balanced with calls to spi_unoptimize_message() to avoid leaking resources.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h **Context**h]j)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h can sleeph]h can sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h **Return**h]j)}(hjh]hReturn}(hj‘hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h+zero on success, else a negative error codeh]h+zero on success, else a negative error code}(hj֑hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j#spi_unoptimize_message (C function)c.spi_unoptimize_messagehNtauh1jhhhhhNhNubj)}(hhh](j)}(h5void spi_unoptimize_message (struct spi_message *msg)h]j)}(h4void spi_unoptimize_message(struct spi_message *msg)h](j4)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj$)}(hspi_unoptimize_messageh]j*)}(hspi_unoptimize_messageh]hspi_unoptimize_message}(hj&hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj"ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjhhhjhMubjl)}(h(struct spi_message *msg)h]jr)}(hstruct spi_message *msgh](j)}(hjh]hstruct}(hjBhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj>ubj)}(h h]h }(hjOhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hj`hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj]ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjbmodnameN classnameNjj)}j]j)}jj(sbc.spi_unoptimize_messageasbuh1hhj>ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj>ubj*)}(hmsgh]hmsg}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj>ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj:ubah}(h]h ]h"]h$]h&]jAjBuh1jkhjhhhjhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhjhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjhhubjX)}(hhh]h)}(h:releases any resources allocated by spi_optimize_message()h]h:releases any resources allocated by spi_optimize_message()}(hjŒhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj’hhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjݒjzjݒj{j|j}uh1jhhhhhNhNubj)}(h**Parameters** ``struct spi_message *msg`` the message to unoptimize **Description** Calls to this function must be balanced with calls to spi_optimize_message(). **Context** can sleeph](h)}(h**Parameters**h]j)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]j)}(h6``struct spi_message *msg`` the message to unoptimize h](j)}(h``struct spi_message *msg``h]h)}(hjh]hstruct spi_message *msg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hthe message to unoptimizeh]hthe message to unoptimize}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubh)}(h**Description**h]j)}(hjAh]h Description}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1jhj?ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hMCalls to this function must be balanced with calls to spi_optimize_message().h]hMCalls to this function must be balanced with calls to spi_optimize_message().}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h **Context**h]j)}(hjhh]hContext}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjfubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h can sleeph]h can sleep}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j&devm_spi_optimize_message (C function)c.devm_spi_optimize_messagehNtauh1jhhhhhNhNubj)}(hhh](j)}(hcint devm_spi_optimize_message (struct device *dev, struct spi_device *spi, struct spi_message *msg)h]j)}(hbint devm_spi_optimize_message(struct device *dev, struct spi_device *spi, struct spi_message *msg)h](j4)}(hinth]hint}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj$)}(hdevm_spi_optimize_messageh]j*)}(hdevm_spi_optimize_messageh]hdevm_spi_optimize_message}(hjΓhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjʓubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjhhhjhMubjl)}(hE(struct device *dev, struct spi_device *spi, struct spi_message *msg)h](jr)}(hstruct device *devh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(hdeviceh]hdevice}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj modnameN classnameNjj)}j]j)}jjГsbc.devm_spi_optimize_messageasbuh1hhjubj)}(h h]h }(hj(hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hj6hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hdevh]hdev}(hjChhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubjr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hj\hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjXubj)}(h h]h }(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjzhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjwubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj|modnameN classnameNjj)}j]j$c.devm_spi_optimize_messageasbuh1hhjXubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjXubj*)}(hspih]hspi}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjXubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubjr)}(hstruct spi_message *msgh](j)}(hjh]hstruct}(hj̔hhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjȔubj)}(h h]h }(hjٔhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjȔubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjmodnameN classnameNjj)}j]j$c.devm_spi_optimize_messageasbuh1hhjȔubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjȔubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjȔubj*)}(hmsgh]hmsg}(hj#hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjȔubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjhhhjhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhjhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjhhubjX)}(hhh]h)}(h)managed version of spi_optimize_message()h]h)managed version of spi_optimize_message()}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjJhhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjejzjej{j|j}uh1jhhhhhNhNubj)}(hX~**Parameters** ``struct device *dev`` the device that manages **msg** (usually **spi->dev**) ``struct spi_device *spi`` the device that will be used for the message ``struct spi_message *msg`` the message to optimize **Return** zero on success, else a negative error code **Description** spi_unoptimize_message() will automatically be called when the device is removed.h](h)}(h**Parameters**h]j)}(hjoh]h Parameters}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjiubj)}(hhh](j)}(hN``struct device *dev`` the device that manages **msg** (usually **spi->dev**) h](j)}(h``struct device *dev``h]h)}(hjh]hstruct device *dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubj)}(hhh]h)}(h6the device that manages **msg** (usually **spi->dev**)h](hthe device that manages }(hjhhhNhNubj)}(h**msg**h]hmsg}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh (usually }(hjhhhNhNubj)}(h **spi->dev**h]hspi->dev}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhjhM hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM hjubj)}(hH``struct spi_device *spi`` the device that will be used for the message h](j)}(h``struct spi_device *spi``h]h)}(hjh]hstruct spi_device *spi}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubj)}(hhh]h)}(h,the device that will be used for the messageh]h,the device that will be used for the message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM hjubj)}(h4``struct spi_message *msg`` the message to optimize h](j)}(h``struct spi_message *msg``h]h)}(hj$h]hstruct spi_message *msg}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjubj)}(hhh]h)}(hthe message to optimizeh]hthe message to optimize}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj9hM hj:ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj9hM hjubeh}(h]h ]h"]h$]h&]uh1jhjiubh)}(h **Return**h]j)}(hj_h]hReturn}(hjahhhNhNubah}(h]h ]h"]h$]h&]uh1jhj]ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjiubh)}(h+zero on success, else a negative error codeh]h+zero on success, else a negative error code}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjiubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(hQspi_unoptimize_message() will automatically be called when the device is removed.h]hQspi_unoptimize_message() will automatically be called when the device is removed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hjiubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_async (C function) c.spi_asynchNtauh1jhhhhhNhNubj)}(hhh](j)}(hCint spi_async (struct spi_device *spi, struct spi_message *message)h]j)}(hBint spi_async(struct spi_device *spi, struct spi_message *message)h](j4)}(hinth]hint}(hj˖hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjǖhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjږhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjǖhhhjٖhMubj$)}(h spi_asynch]j*)}(h spi_asynch]h spi_async}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjǖhhhjٖhMubjl)}(h5(struct spi_device *spi, struct spi_message *message)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hj&hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj#ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj(modnameN classnameNjj)}j]j)}jjsb c.spi_asyncasbuh1hhjubj)}(h h]h }(hjFhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjThhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hspih]hspi}(hjahhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubjr)}(hstruct spi_message *messageh](j)}(hjh]hstruct}(hjzhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjvubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjmodnameN classnameNjj)}j]jB c.spi_asyncasbuh1hhjvubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvubj)}(hjh]h*}(hjėhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjvubj*)}(hmessageh]hmessage}(hjїhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjvubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjǖhhhjٖhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjÖhhhjٖhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjٖhMhjhhubjX)}(hhh]h)}(hasynchronous SPI transferh]hasynchronous SPI transfer}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjٖhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_device *spi`` device with which data will be exchanged ``struct spi_message *message`` describes the data transfers, including completion callback **Context** any (IRQs may be blocked, etc) **Description** This call may be used in_irq and other contexts which can't sleep, as well as from task contexts which can sleep. The completion callback is invoked in a context which can't sleep. Before that invocation, the value of message->status is undefined. When the callback is issued, message->status holds either zero (to indicate complete success) or a negative error code. After that callback returns, the driver which issued the transfer request may deallocate the associated memory; it's no longer in use by any SPI core or controller driver code. Note that although all messages to a spi_device are handled in FIFO order, messages may go to different devices in other orders. Some device might be higher priority, or have various "hard" access time requirements, for example. On detection of any fault during the transfer, processing of the entire message is aborted, and the device is deselected. Until returning from the associated message completion callback, no other spi_message queued to that device will be processed. (This rule applies equally to all the synchronous transfer calls, which are wrappers around this core asynchronous primitive.) **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjh]h Parameters}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM#hjubj)}(hhh](j)}(hD``struct spi_device *spi`` device with which data will be exchanged h](j)}(h``struct spi_device *spi``h]h)}(hj<h]hstruct spi_device *spi}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj:ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM hj6ubj)}(hhh]h)}(h(device with which data will be exchangedh]h(device with which data will be exchanged}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQhM hjRubah}(h]h ]h"]h$]h&]uh1jhj6ubeh}(h]h ]h"]h$]h&]uh1jhjQhM hj3ubj)}(h\``struct spi_message *message`` describes the data transfers, including completion callback h](j)}(h``struct spi_message *message``h]h)}(hjuh]hstruct spi_message *message}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjsubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM!hjoubj)}(hhh]h)}(h;describes the data transfers, including completion callbackh]h;describes the data transfers, including completion callback}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM!hjubah}(h]h ]h"]h$]h&]uh1jhjoubeh}(h]h ]h"]h$]h&]uh1jhjhM!hj3ubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Context**h]j)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM#hjubh)}(hany (IRQs may be blocked, etc)h]hany (IRQs may be blocked, etc)}(hjƘhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM"hjubh)}(h**Description**h]j)}(hjטh]h Description}(hj٘hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj՘ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM$hjubh)}(hqThis call may be used in_irq and other contexts which can't sleep, as well as from task contexts which can sleep.h]hsThis call may be used in_irq and other contexts which can’t sleep, as well as from task contexts which can sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM#hjubh)}(hXThe completion callback is invoked in a context which can't sleep. Before that invocation, the value of message->status is undefined. When the callback is issued, message->status holds either zero (to indicate complete success) or a negative error code. After that callback returns, the driver which issued the transfer request may deallocate the associated memory; it's no longer in use by any SPI core or controller driver code.h]hXThe completion callback is invoked in a context which can’t sleep. Before that invocation, the value of message->status is undefined. When the callback is issued, message->status holds either zero (to indicate complete success) or a negative error code. After that callback returns, the driver which issued the transfer request may deallocate the associated memory; it’s no longer in use by any SPI core or controller driver code.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM&hjubh)}(hNote that although all messages to a spi_device are handled in FIFO order, messages may go to different devices in other orders. Some device might be higher priority, or have various "hard" access time requirements, for example.h]hNote that although all messages to a spi_device are handled in FIFO order, messages may go to different devices in other orders. Some device might be higher priority, or have various “hard” access time requirements, for example.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM.hjubh)}(hXwOn detection of any fault during the transfer, processing of the entire message is aborted, and the device is deselected. Until returning from the associated message completion callback, no other spi_message queued to that device will be processed. (This rule applies equally to all the synchronous transfer calls, which are wrappers around this core asynchronous primitive.)h]hXwOn detection of any fault during the transfer, processing of the entire message is aborted, and the device is deselected. Until returning from the associated message completion callback, no other spi_message queued to that device will be processed. (This rule applies equally to all the synchronous transfer calls, which are wrappers around this core asynchronous primitive.)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM3hjubh)}(h **Return**h]j)}(hj+h]hReturn}(hj-hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj)ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM:hjubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM;hjubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_sync (C function) c.spi_synchNtauh1jhhhhhNhNubj)}(hhh](j)}(hBint spi_sync (struct spi_device *spi, struct spi_message *message)h]j)}(hAint spi_sync(struct spi_device *spi, struct spi_message *message)h](j4)}(hinth]hint}(hjphhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjlhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjlhhhj~hMubj$)}(hspi_synch]j*)}(hspi_synch]hspi_sync}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjlhhhj~hMubjl)}(h5(struct spi_device *spi, struct spi_message *message)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hj˙hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjșubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj͙modnameN classnameNjj)}j]j)}jjsb c.spi_syncasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hspih]hspi}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubjr)}(hstruct spi_message *messageh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hj,hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hj=hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj:ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj?modnameN classnameNjj)}j]j c.spi_syncasbuh1hhjubj)}(h h]h }(hj[hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjihhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hmessageh]hmessage}(hjvhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjlhhhj~hMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhhj~hMubah}(h]jcah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhj~hMhjehhubjX)}(hhh]h)}(h'blocking/synchronous SPI data transfersh]h'blocking/synchronous SPI data transfers}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjhhubah}(h]h ]h"]h$]h&]uh1jWhjehhhj~hMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjjzjj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_device *spi`` device with which data will be exchanged ``struct spi_message *message`` describes the data transfers **Context** can sleep **Description** This call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. Low-overhead controller drivers may DMA directly into and out of the message buffers. Note that the SPI device's chip select is active during the message, and then is normally disabled between messages. Drivers for some frequently-used devices may want to minimize costs of selecting a chip, by leaving it selected in anticipation that the next message will go to the same chip. (That may increase power usage.) Also, the caller is guaranteeing that the memory associated with the message will not be freed before this call returns. **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjšh]h Parameters}(hjĚhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh](j)}(hD``struct spi_device *spi`` device with which data will be exchanged h](j)}(h``struct spi_device *spi``h]h)}(hjh]hstruct spi_device *spi}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjߚubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjۚubj)}(hhh]h)}(h(device with which data will be exchangedh]h(device with which data will be exchanged}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjۚubeh}(h]h ]h"]h$]h&]uh1jhjhMhjؚubj)}(h=``struct spi_message *message`` describes the data transfers h](j)}(h``struct spi_message *message``h]h)}(hjh]hstruct spi_message *message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hdescribes the data transfersh]hdescribes the data transfers}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj/hMhj0ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhj/hMhjؚubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(h **Context**h]j)}(hjUh]hContext}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjSubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h can sleeph]h can sleep}(hjkhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h**Description**h]j)}(hj|h]h Description}(hj~hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjzubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. Low-overhead controller drivers may DMA directly into and out of the message buffers.h]hThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. Low-overhead controller drivers may DMA directly into and out of the message buffers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hXGNote that the SPI device's chip select is active during the message, and then is normally disabled between messages. Drivers for some frequently-used devices may want to minimize costs of selecting a chip, by leaving it selected in anticipation that the next message will go to the same chip. (That may increase power usage.)h]hXINote that the SPI device’s chip select is active during the message, and then is normally disabled between messages. Drivers for some frequently-used devices may want to minimize costs of selecting a chip, by leaving it selected in anticipation that the next message will go to the same chip. (That may increase power usage.)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(hxAlso, the caller is guaranteeing that the memory associated with the message will not be freed before this call returns.h]hxAlso, the caller is guaranteeing that the memory associated with the message will not be freed before this call returns.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h **Return**h]j)}(hjh]hReturn}(hjÛhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjכhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_sync_locked (C function)c.spi_sync_lockedhNtauh1jhhhhhNhNubj)}(hhh](j)}(hIint spi_sync_locked (struct spi_device *spi, struct spi_message *message)h]j)}(hHint spi_sync_locked(struct spi_device *spi, struct spi_message *message)h](j4)}(hinth]hint}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj$)}(hspi_sync_lockedh]j*)}(hspi_sync_lockedh]hspi_sync_locked}(hj'hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj#ubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjhhhjhMubjl)}(h5(struct spi_device *spi, struct spi_message *message)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjChhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhj?ubj)}(h h]h }(hjPhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjahhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj^ubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjcmodnameN classnameNjj)}j]j)}jj)sbc.spi_sync_lockedasbuh1hhj?ubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhj?ubj*)}(hspih]hspi}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hj?ubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj;ubjr)}(hstruct spi_message *messageh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjœhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(h spi_messageh]h spi_message}(hjӜhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjМubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetj՜modnameN classnameNjj)}j]j}c.spi_sync_lockedasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hmessageh]hmessage}(hj hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj;ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjhhhjhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhjhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjhhubjX)}(hhh]h)}(h,version of spi_sync with exclusive bus usageh]h,version of spi_sync with exclusive bus usage}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj3hhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjNjzjNj{j|j}uh1jhhhhhNhNubj)}(hX**Parameters** ``struct spi_device *spi`` device with which data will be exchanged ``struct spi_message *message`` describes the data transfers **Context** can sleep **Description** This call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. Low-overhead controller drivers may DMA directly into and out of the message buffers. This call should be used by drivers that require exclusive access to the SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must be released by a spi_bus_unlock call when the exclusive access is over. **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hjXh]h Parameters}(hjZhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjVubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubj)}(hhh](j)}(hD``struct spi_device *spi`` device with which data will be exchanged h](j)}(h``struct spi_device *spi``h]h)}(hjwh]hstruct spi_device *spi}(hjyhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjuubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjqubj)}(hhh]h)}(h(device with which data will be exchangedh]h(device with which data will be exchanged}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjqubeh}(h]h ]h"]h$]h&]uh1jhjhMhjnubj)}(h=``struct spi_message *message`` describes the data transfers h](j)}(h``struct spi_message *message``h]h)}(hjh]hstruct spi_message *message}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hdescribes the data transfersh]hdescribes the data transfers}(hjɝhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjŝhMhjƝubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjŝhMhjnubeh}(h]h ]h"]h$]h&]uh1jhjRubh)}(h **Context**h]j)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubh)}(h can sleeph]h can sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubh)}(hThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. Low-overhead controller drivers may DMA directly into and out of the message buffers.h]hThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. Low-overhead controller drivers may DMA directly into and out of the message buffers.}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubh)}(hThis call should be used by drivers that require exclusive access to the SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must be released by a spi_bus_unlock call when the exclusive access is over.h]hThis call should be used by drivers that require exclusive access to the SPI bus. It has to be preceded by a spi_bus_lock call. The SPI bus must be released by a spi_bus_unlock call when the exclusive access is over.}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubh)}(h **Return**h]j)}(hjHh]hReturn}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjFubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjRubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_bus_lock (C function)c.spi_bus_lockhNtauh1jhhhhhNhNubj)}(hhh](j)}(h.int spi_bus_lock (struct spi_controller *ctlr)h]j)}(h-int spi_bus_lock(struct spi_controller *ctlr)h](j4)}(hinth]hint}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjhhhjhMubj$)}(h spi_bus_lockh]j*)}(h spi_bus_lockh]h spi_bus_lock}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjhhhjhMubjl)}(h(struct spi_controller *ctlr)h]jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjʞhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjƞubj)}(h h]h }(hjמhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjƞubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjmodnameN classnameNjj)}j]j)}jjsbc.spi_bus_lockasbuh1hhjƞubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjƞubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjƞubj*)}(hctlrh]hctlr}(hj#hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjƞubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjžubah}(h]h ]h"]h$]h&]jAjBuh1jkhjhhhjhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjhhhjhMubah}(h]jah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjhMhjhhubjX)}(hhh]h)}(h)obtain a lock for exclusive SPI bus usageh]h)obtain a lock for exclusive SPI bus usage}(hjMhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjJhhubah}(h]h ]h"]h$]h&]uh1jWhjhhhjhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjejzjej{j|j}uh1jhhhhhNhNubj)}(hX:**Parameters** ``struct spi_controller *ctlr`` SPI bus controller that should be locked for exclusive bus access **Context** can sleep **Description** This call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. This call should be used by drivers that require exclusive access to the SPI bus. The SPI bus must be released by a spi_bus_unlock call when the exclusive access is over. Data transfer must be done by spi_sync_locked and spi_async_locked calls when the SPI bus lock is held. **Return** always zero.h](h)}(h**Parameters**h]j)}(hjoh]h Parameters}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjmubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubj)}(hhh]j)}(hb``struct spi_controller *ctlr`` SPI bus controller that should be locked for exclusive bus access h](j)}(h``struct spi_controller *ctlr``h]h)}(hjh]hstruct spi_controller *ctlr}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjubj)}(hhh]h)}(hASPI bus controller that should be locked for exclusive bus accessh]hASPI bus controller that should be locked for exclusive bus access}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjiubh)}(h **Context**h]j)}(hjɟh]hContext}(hj˟hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjǟubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(h can sleeph]h can sleep}(hjߟhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(hnThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout.h]hnThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(hXThis call should be used by drivers that require exclusive access to the SPI bus. The SPI bus must be released by a spi_bus_unlock call when the exclusive access is over. Data transfer must be done by spi_sync_locked and spi_async_locked calls when the SPI bus lock is held.h]hXThis call should be used by drivers that require exclusive access to the SPI bus. The SPI bus must be released by a spi_bus_unlock call when the exclusive access is over. Data transfer must be done by spi_sync_locked and spi_async_locked calls when the SPI bus lock is held.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(h **Return**h]j)}(hj&h]hReturn}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj$ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubh)}(h always zero.h]h always zero.}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjiubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](jspi_bus_unlock (C function)c.spi_bus_unlockhNtauh1jhhhhhNhNubj)}(hhh](j)}(h0int spi_bus_unlock (struct spi_controller *ctlr)h]j)}(h/int spi_bus_unlock(struct spi_controller *ctlr)h](j4)}(hinth]hint}(hjkhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjghhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMubj)}(h h]h }(hjzhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjghhhjyhMubj$)}(hspi_bus_unlockh]j*)}(hspi_bus_unlockh]hspi_bus_unlock}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjghhhjyhMubjl)}(h(struct spi_controller *ctlr)h]jr)}(hstruct spi_controller *ctlrh](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(hspi_controllerh]hspi_controller}(hjƠhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjàubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjȠmodnameN classnameNjj)}j]j)}jjsbc.spi_bus_unlockasbuh1hhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hctlrh]hctlr}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhjubah}(h]h H]h"]h$]h&]jAjBuh1jkhjghhhjyhMubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjchhhjyhMubah}(h]j^ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjyhMhj`hhubjX)}(hhh]h)}(h,release the lock for exclusive SPI bus usageh]h,release the lock for exclusive SPI bus usage}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhj(hhubah}(h]h ]h"]h$]h&]uh1jWhj`hhhjyhMubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyjCjzjCj{j|j}uh1jhhhhhNhNubj)}(hXq**Parameters** ``struct spi_controller *ctlr`` SPI bus controller that was locked for exclusive bus access **Context** can sleep **Description** This call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout. This call releases an SPI bus lock previously obtained by an spi_bus_lock call. **Return** always zero.h](h)}(h**Parameters**h]j)}(hjMh]h Parameters}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjKubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubj)}(hhh]j)}(h\``struct spi_controller *ctlr`` SPI bus controller that was locked for exclusive bus access h](j)}(h``struct spi_controller *ctlr``h]h)}(hjlh]hstruct spi_controller *ctlr}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjfubj)}(hhh]h)}(h;SPI bus controller that was locked for exclusive bus accessh]h;SPI bus controller that was locked for exclusive bus access}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhMhjubah}(h]h ]h"]h$]h&]uh1jhjfubeh}(h]h ]h"]h$]h&]uh1jhjhMhjcubah}(h]h ]h"]h$]h&]uh1jhjGubh)}(h **Context**h]j)}(hjh]hContext}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubh)}(h can sleeph]h can sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubh)}(h**Description**h]j)}(hjΡh]h Description}(hjСhhhNhNubah}(h]h ]h"]h$]h&]uh1jhj̡ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubh)}(hnThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout.h]hnThis call may only be used from a context that may sleep. The sleep is non-interruptible, and has no timeout.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubh)}(hOThis call releases an SPI bus lock previously obtained by an spi_bus_lock call.h]hOThis call releases an SPI bus lock previously obtained by an spi_bus_lock call.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubh)}(h **Return**h]j)}(hjh]hReturn}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubh)}(h always zero.h]h always zero.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMhjGubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubj)}(hhh]h}(h]h ]h"]h$]h&]entries](j spi_write_then_read (C function)c.spi_write_then_readhNtauh1jhhhhhNhNubj)}(hhh](j)}(hnint spi_write_then_read (struct spi_device *spi, const void *txbuf, unsigned n_tx, void *rxbuf, unsigned n_rx)h]j)}(hmint spi_write_then_read(struct spi_device *spi, const void *txbuf, unsigned n_tx, void *rxbuf, unsigned n_rx)h](j4)}(hinth]hint}(hjIhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjEhhhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM1ubj)}(h h]h }(hjXhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjEhhhjWhM1ubj$)}(hspi_write_then_readh]j*)}(hspi_write_then_readh]hspi_write_then_read}(hjjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjfubah}(h]h ](j<j=eh"]h$]h&]jAjBuh1j#hjEhhhjWhM1ubjl)}(hV(struct spi_device *spi, const void *txbuf, unsigned n_tx, void *rxbuf, unsigned n_rx)h](jr)}(hstruct spi_device *spih](j)}(hjh]hstruct}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubh)}(hhh]j*)}(h spi_deviceh]h spi_device}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubah}(h]h ]h"]h$]h&] refdomainjreftypej reftargetjmodnameN classnameNjj)}j]j)}jjlsbc.spi_write_then_readasbuh1hhjubj)}(h h]h }(hjĢhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjҢhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hspih]hspi}(hjߢhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubjr)}(hconst void *txbufh](j)}(hjHh]hconst}(hjhhhNhNubah}(h]h ]j ah"]h$]h&]uh1jhjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj4)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjubj)}(h h]h }(hj!hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hj/hhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(htxbufh]htxbuf}(hj<hhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubjr)}(h unsigned n_txh](j4)}(hunsignedh]hunsigned}(hjUhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjQubj)}(h h]h }(hjchhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjQubj*)}(hn_txh]hn_tx}(hjqhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjQubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubjr)}(h void *rxbufh](j4)}(hvoidh]hvoid}(hjhhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjubj)}(h h]h }(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj)}(hjh]h*}(hjhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjubj*)}(hrxbufh]hrxbuf}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubjr)}(h unsigned n_rxh](j4)}(hunsignedh]hunsigned}(hj̣hhhNhNubah}(h]h ]j@ah"]h$]h&]uh1j3hjȣubj)}(h h]h }(hjڣhhhNhNubah}(h]h ]jah"]h$]h&]uh1jhjȣubj*)}(hn_rxh]hn_rx}(hjhhhNhNubah}(h]h ]j5ah"]h$]h&]uh1j)hjȣubeh}(h]h ]h"]h$]h&]noemphjAjBuh1jqhj~ubeh}(h]h ]h"]h$]h&]jAjBuh1jkhjEhhhjWhM1ubeh}(h]h ]h"]h$]h&]jAjBjIuh1jjJjKhjAhhhjWhM1ubah}(h]j<ah ](jOjPeh"]h$]h&]jTjU)jVhuh1jhjWhM1hj>hhubjX)}(hhh]h)}(h&SPI synchronous write followed by readh]h&SPI synchronous write followed by read}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM1hjhhubah}(h]h ]h"]h$]h&]uh1jWhj>hhhjWhM1ubeh}(h]h ](jfunctioneh"]h$]h&]jxjjyj*jzj*j{j|j}uh1jhhhhhNhNubj)}(hXJ**Parameters** ``struct spi_device *spi`` device with which data will be exchanged ``const void *txbuf`` data to be written (need not be DMA-safe) ``unsigned n_tx`` size of txbuf, in bytes ``void *rxbuf`` buffer into which data will be read (need not be DMA-safe) ``unsigned n_rx`` size of rxbuf, in bytes **Context** can sleep **Description** This performs a half duplex MicroWire style transaction with the device, sending txbuf and then reading rxbuf. The return value is zero for success, else a negative errno status code. This call may only be used from a context that may sleep. Parameters to this routine are always copied using a small buffer. Performance-sensitive or bulk transfer code should instead use spi_{async,sync}() calls with DMA-safe buffers. **Return** zero on success, else a negative error code.h](h)}(h**Parameters**h]j)}(hj4h]h Parameters}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj2ubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM5hj.ubj)}(hhh](j)}(hD``struct spi_device *spi`` device with which data will be exchanged h](j)}(h``struct spi_device *spi``h]h)}(hjSh]hstruct spi_device *spi}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjQubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM2hjMubj)}(hhh]h)}(h(device with which data will be exchangedh]h(device with which data will be exchanged}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhM2hjiubah}(h]h ]h"]h$]h&]uh1jhjMubeh}(h]h ]h"]h$]h&]uh1jhjhhM2hjJubj)}(h@``const void *txbuf`` data to be written (need not be DMA-safe) h](j)}(h``const void *txbuf``h]h)}(hjh]hconst void *txbuf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM3hjubj)}(hhh]h)}(h)data to be written (need not be DMA-safe)h]h)data to be written (need not be DMA-safe)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM3hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM3hjJubj)}(h*``unsigned n_tx`` size of txbuf, in bytes h](j)}(h``unsigned n_tx``h]h)}(hjŤh]h unsigned n_tx}(hjǤhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjäubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM4hjubj)}(hhh]h)}(hsize of txbuf, in bytesh]hsize of txbuf, in bytes}(hjޤhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjڤhM4hjۤubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjڤhM4hjJubj)}(hK``void *rxbuf`` buffer into which data will be read (need not be DMA-safe) h](j)}(h``void *rxbuf``h]h)}(hjh]h void *rxbuf}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM5hjubj)}(hhh]h)}(h:buffer into which data will be read (need not be DMA-safe)h]h:buffer into which data will be read (need not be DMA-safe)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhM5hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjhM5hjJubj)}(h*``unsigned n_rx`` size of rxbuf, in bytes h](j)}(h``unsigned n_rx``h]h)}(hj7h]h unsigned n_rx}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj5ubah}(h]h ]h"]h$]h&]uh1jhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM6hj1ubj)}(hhh]h)}(hsize of rxbuf, in bytesh]hsize of rxbuf, in bytes}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjLhM6hjMubah}(h]h ]h"]h$]h&]uh1jhj1ubeh}(h]h ]h"]h$]h&]uh1jhjLhM6hjJubeh}(h]h ]h"]h$]h&]uh1jhj.ubh)}(h **Context**h]j)}(hjrh]hContext}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jhjpubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM8hj.ubh)}(h can sleeph]h can sleep}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM7hj.ubh)}(h**Description**h]j)}(hjh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM9hj.ubh)}(hThis performs a half duplex MicroWire style transaction with the device, sending txbuf and then reading rxbuf. The return value is zero for success, else a negative errno status code. This call may only be used from a context that may sleep.h]hThis performs a half duplex MicroWire style transaction with the device, sending txbuf and then reading rxbuf. The return value is zero for success, else a negative errno status code. This call may only be used from a context that may sleep.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM8hj.ubh)}(hParameters to this routine are always copied using a small buffer. Performance-sensitive or bulk transfer code should instead use spi_{async,sync}() calls with DMA-safe buffers.h]hParameters to this routine are always copied using a small buffer. Performance-sensitive or bulk transfer code should instead use spi_{async,sync}() calls with DMA-safe buffers.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chM=hj.ubh)}(h **Return**h]j)}(hjϥh]hReturn}(hjѥhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjͥubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMAhj.ubh)}(h,zero on success, else a negative error code.h]h,zero on success, else a negative error code.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhP/var/lib/git/docbuild/linux/Documentation/driver-api/spi:52: ./drivers/spi/spi.chMBhj.ubeh}(h]h ] kernelindentah"]h$]h&]uh1j~hhhhhNhNubeh}(h]serial-peripheral-interface-spiah ]h"]!serial peripheral interface (spi)ah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksj9>footnote_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}jjs nametypes}jsh}(jhjjjjjjjjj&j+jjjjj'j'j)j)j/3j43j7j7jS:jX:j<j<j?j?j=BjBBjDjDjGjGjJjJjMjMjPj#PjRjRjUjUjXjXjZjZj\j\j^j^j`j`jHcjMcjdjdjJfjOfjijijljljnjnjpjpjrjrj ujujvjvjyjyj{j{jI~jN~jkjpjhjmjjjjjjjjjbjgjjjjjjÖjcjhjjjjj^jcj<jAu 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.