sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget(/translations/zh_CN/networking/caif/caifmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/zh_TW/networking/caif/caifmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/it_IT/networking/caif/caifmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/ja_JP/networking/caif/caifmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/ko_KR/networking/caif/caifmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget(/translations/sp_SP/networking/caif/caifmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhB/var/lib/git/docbuild/linux/Documentation/networking/caif/caif.rsthKubh)}(h4This data file has been placed in the public domain.h]h4This data file has been placed in the public domain.}hhsbah}(h]h ]h"]h$]h&]hhuh1hhhhhho/srv/docbuild/lib/venvs/build-kernel-docs/lib64/python3.9/site-packages/docutils/parsers/rst/include/isonum.txthKubh)}(hDerived from the Unicode character mappings available from . Processed by unicode2rstsubs.py, part of Docutils: .h]hDerived from the Unicode character mappings available from . Processed by unicode2rstsubs.py, part of Docutils: .}hhsbah}(h]h ]h"]h$]h&]hhuh1hhhhhhhhKubhsubstitution_definition)}(h*.. |amp| unicode:: U+00026 .. AMPERSANDh]h&}hhsbah}(h]h ]h"]ampah$]h&]uh1hhhhKhhhhubh)}(h+.. |apos| unicode:: U+00027 .. APOSTROPHEh]h'}hhsbah}(h]h ]h"]aposah$]h&]uh1hhhhKhhhhubh)}(h).. |ast| unicode:: U+0002A .. ASTERISKh]h*}hhsbah}(h]h ]h"]astah$]h&]uh1hhhhK hhhhubh)}(h+.. |brvbar| unicode:: U+000A6 .. BROKEN BARh]h¦}hjsbah}(h]h ]h"]brvbarah$]h&]uh1hhhhK hhhhubh)}(h0.. |bsol| unicode:: U+0005C .. REVERSE SOLIDUSh]h\}hjsbah}(h]h ]h"]bsolah$]h&]uh1hhhhK hhhhubh)}(h*.. |cent| unicode:: U+000A2 .. CENT SIGNh]h¢}hjsbah}(h]h ]h"]centah$]h&]uh1hhhhK hhhhubh)}(h&.. |colon| unicode:: U+0003A .. COLONh]h:}hj-sbah}(h]h ]h"]colonah$]h&]uh1hhhhK hhhhubh)}(h&.. |comma| unicode:: U+0002C .. COMMAh]h,}hj<sbah}(h]h ]h"]commaah$]h&]uh1hhhhKhhhhubh)}(h... |commat| unicode:: U+00040 .. COMMERCIAL ATh]h@}hjKsbah}(h]h ]h"]commatah$]h&]uh1hhhhKhhhhubh)}(h/.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGNh]h©}hjZsbah}(h]h ]h"]copyah$]h&]uh1hhhhKhhhhubh)}(h... |curren| unicode:: U+000A4 .. CURRENCY SIGNh]h¤}hjisbah}(h]h ]h"]currenah$]h&]uh1hhhhKhhhhubh)}(h0.. |darr| unicode:: U+02193 .. DOWNWARDS ARROWh]h↓}hjxsbah}(h]h ]h"]darrah$]h&]uh1hhhhKhhhhubh)}(h,.. |deg| unicode:: U+000B0 .. DEGREE SIGNh]h°}hjsbah}(h]h ]h"]degah$]h&]uh1hhhhKhhhhubh)}(h... |divide| unicode:: U+000F7 .. DIVISION SIGNh]h÷}hjsbah}(h]h ]h"]divideah$]h&]uh1hhhhKhhhhubh)}(h,.. |dollar| unicode:: U+00024 .. DOLLAR SIGNh]h$}hjsbah}(h]h ]h"]dollarah$]h&]uh1hhhhKhhhhubh)}(h,.. |equals| unicode:: U+0003D .. EQUALS SIGNh]h=}hjsbah}(h]h ]h"]equalsah$]h&]uh1hhhhKhhhhubh)}(h1.. |excl| unicode:: U+00021 .. EXCLAMATION MARKh]h!}hjsbah}(h]h ]h"]exclah$]h&]uh1hhhhKhhhhubh)}(h9.. |frac12| unicode:: U+000BD .. VULGAR FRACTION ONE HALFh]h½}hjsbah}(h]h ]h"]frac12ah$]h&]uh1hhhhKhhhhubh)}(h<.. |frac14| unicode:: U+000BC .. VULGAR FRACTION ONE QUARTERh]h¼}hjsbah}(h]h ]h"]frac14ah$]h&]uh1hhhhKhhhhubh)}(h;.. |frac18| unicode:: U+0215B .. VULGAR FRACTION ONE EIGHTHh]h⅛}hjsbah}(h]h ]h"]frac18ah$]h&]uh1hhhhKhhhhubh)}(h?.. |frac34| unicode:: U+000BE .. VULGAR FRACTION THREE QUARTERSh]h¾}hjsbah}(h]h ]h"]frac34ah$]h&]uh1hhhhKhhhhubh)}(h>.. |frac38| unicode:: U+0215C .. VULGAR FRACTION THREE EIGHTHSh]h⅜}hjsbah}(h]h ]h"]frac38ah$]h&]uh1hhhhKhhhhubh)}(h=.. |frac58| unicode:: U+0215D .. VULGAR FRACTION FIVE EIGHTHSh]h⅝}hjsbah}(h]h ]h"]frac58ah$]h&]uh1hhhhKhhhhubh)}(h>.. |frac78| unicode:: U+0215E .. VULGAR FRACTION SEVEN EIGHTHSh]h⅞}hj,sbah}(h]h ]h"]frac78ah$]h&]uh1hhhhKhhhhubh)}(h2.. |gt| unicode:: U+0003E .. GREATER-THAN SIGNh]h>}hj;sbah}(h]h ]h"]gtah$]h&]uh1hhhhKhhhhubh)}(h9.. |half| unicode:: U+000BD .. VULGAR FRACTION ONE HALFh]h½}hjJsbah}(h]h ]h"]halfah$]h&]uh1hhhhK hhhhubh)}(h/.. |horbar| unicode:: U+02015 .. HORIZONTAL BARh]h―}hjYsbah}(h]h ]h"]horbarah$]h&]uh1hhhhK!hhhhubh)}(h'.. |hyphen| unicode:: U+02010 .. HYPHENh]h‐}hjhsbah}(h]h ]h"]hyphenah$]h&]uh1hhhhK"hhhhubh)}(h:.. |iexcl| unicode:: U+000A1 .. INVERTED EXCLAMATION MARKh]h¡}hjwsbah}(h]h ]h"]iexclah$]h&]uh1hhhhK#hhhhubh)}(h7.. |iquest| unicode:: U+000BF .. INVERTED QUESTION MARKh]h¿}hjsbah}(h]h ]h"]iquestah$]h&]uh1hhhhK$hhhhubh)}(hJ.. |laquo| unicode:: U+000AB .. LEFT-POINTING DOUBLE ANGLE QUOTATION MARKh]h«}hjsbah}(h]h ]h"]laquoah$]h&]uh1hhhhK%hhhhubh)}(h0.. |larr| unicode:: U+02190 .. LEFTWARDS ARROWh]h←}hjsbah}(h]h ]h"]larrah$]h&]uh1hhhhK&hhhhubh)}(h3.. |lcub| unicode:: U+0007B .. LEFT CURLY BRACKETh]h{}hjsbah}(h]h ]h"]lcubah$]h&]uh1hhhhK'hhhhubh)}(h;.. |ldquo| unicode:: U+0201C .. LEFT DOUBLE QUOTATION MARKh]h“}hjsbah}(h]h ]h"]ldquoah$]h&]uh1hhhhK(hhhhubh)}(h).. |lowbar| unicode:: U+0005F .. LOW LINEh]h_}hjsbah}(h]h ]h"]lowbarah$]h&]uh1hhhhK)hhhhubh)}(h1.. |lpar| unicode:: U+00028 .. LEFT PARENTHESISh]h(}hjsbah}(h]h ]h"]lparah$]h&]uh1hhhhK*hhhhubh)}(h4.. |lsqb| unicode:: U+0005B .. LEFT SQUARE BRACKETh]h[}hjsbah}(h]h ]h"]lsqbah$]h&]uh1hhhhK+hhhhubh)}(h;.. |lsquo| unicode:: U+02018 .. LEFT SINGLE QUOTATION MARKh]h‘}hjsbah}(h]h ]h"]lsquoah$]h&]uh1hhhhK,hhhhubh)}(h/.. |lt| unicode:: U+0003C .. LESS-THAN SIGNh]h<}hj sbah}(h]h ]h"]ltah$]h&]uh1hhhhK-hhhhubh)}(h+.. |micro| unicode:: U+000B5 .. MICRO SIGNh]hµ}hjsbah}(h]h ]h"]microah$]h&]uh1hhhhK.hhhhubh)}(h+.. |middot| unicode:: U+000B7 .. MIDDLE DOTh]h·}hj+sbah}(h]h ]h"]middotah$]h&]uh1hhhhK/hhhhubh)}(h/.. |nbsp| unicode:: U+000A0 .. NO-BREAK SPACEh]h }hj:sbah}(h]h ]h"]nbspah$]h&]uh1hhhhK0hhhhubh)}(h).. |not| unicode:: U+000AC .. NOT SIGNh]h¬}hjIsbah}(h]h ]h"]notah$]h&]uh1hhhhK1hhhhubh)}(h,.. |num| unicode:: U+00023 .. NUMBER SIGNh]h#}hjXsbah}(h]h ]h"]numah$]h&]uh1hhhhK2hhhhubh)}(h).. |ohm| unicode:: U+02126 .. OHM SIGNh]hΩ}hjgsbah}(h]h ]h"]ohmah$]h&]uh1hhhhK3hhhhubh)}(h;.. |ordf| unicode:: U+000AA .. FEMININE ORDINAL INDICATORh]hª}hjvsbah}(h]h ]h"]ordfah$]h&]uh1hhhhK4hhhhubh)}(h<.. |ordm| unicode:: U+000BA .. MASCULINE ORDINAL INDICATORh]hº}hjsbah}(h]h ]h"]ordmah$]h&]uh1hhhhK5hhhhubh)}(h-.. |para| unicode:: U+000B6 .. PILCROW SIGNh]h¶}hjsbah}(h]h ]h"]paraah$]h&]uh1hhhhK6hhhhubh)}(h-.. |percnt| unicode:: U+00025 .. PERCENT SIGNh]h%}hjsbah}(h]h ]h"]percntah$]h&]uh1hhhhK7hhhhubh)}(h*.. |period| unicode:: U+0002E .. FULL STOPh]h.}hjsbah}(h]h ]h"]periodah$]h&]uh1hhhhK8hhhhubh)}(h*.. |plus| unicode:: U+0002B .. PLUS SIGNh]h+}hjsbah}(h]h ]h"]plusah$]h&]uh1hhhhK9hhhhubh)}(h0.. |plusmn| unicode:: U+000B1 .. PLUS-MINUS SIGNh]h±}hjsbah}(h]h ]h"]plusmnah$]h&]uh1hhhhK:hhhhubh)}(h+.. |pound| unicode:: U+000A3 .. POUND SIGNh]h£}hjsbah}(h]h ]h"]poundah$]h&]uh1hhhhK;hhhhubh)}(h... |quest| unicode:: U+0003F .. QUESTION MARKh]h?}hjsbah}(h]h ]h"]questah$]h&]uh1hhhhKhhhhubh)}(h1.. |rarr| unicode:: U+02192 .. RIGHTWARDS ARROWh]h→}hjsbah}(h]h ]h"]rarrah$]h&]uh1hhhhK?hhhhubh)}(h4.. |rcub| unicode:: U+0007D .. RIGHT CURLY BRACKETh]h}}hj*sbah}(h]h ]h"]rcubah$]h&]uh1hhhhK@hhhhubh)}(h<.. |rdquo| unicode:: U+0201D .. RIGHT DOUBLE QUOTATION MARKh]h”}hj9sbah}(h]h ]h"]rdquoah$]h&]uh1hhhhKAhhhhubh)}(h0.. |reg| unicode:: U+000AE .. REGISTERED SIGNh]h®}hjHsbah}(h]h ]h"]regah$]h&]uh1hhhhKBhhhhubh)}(h2.. |rpar| unicode:: U+00029 .. RIGHT PARENTHESISh]h)}hjWsbah}(h]h ]h"]rparah$]h&]uh1hhhhKChhhhubh)}(h5.. |rsqb| unicode:: U+0005D .. RIGHT SQUARE BRACKETh]h]}hjfsbah}(h]h ]h"]rsqbah$]h&]uh1hhhhKDhhhhubh)}(h<.. |rsquo| unicode:: U+02019 .. RIGHT SINGLE QUOTATION MARKh]h’}hjusbah}(h]h ]h"]rsquoah$]h&]uh1hhhhKEhhhhubh)}(h-.. |sect| unicode:: U+000A7 .. SECTION SIGNh]h§}hjsbah}(h]h ]h"]sectah$]h&]uh1hhhhKFhhhhubh)}(h*.. |semi| unicode:: U+0003B .. SEMICOLONh]h;}hjsbah}(h]h ]h"]semiah$]h&]uh1hhhhKGhhhhubh)}(h,.. |shy| unicode:: U+000AD .. SOFT HYPHENh]h­}hjsbah}(h]h ]h"]shyah$]h&]uh1hhhhKHhhhhubh)}(h(.. |sol| unicode:: U+0002F .. SOLIDUSh]h/}hjsbah}(h]h ]h"]solah$]h&]uh1hhhhKIhhhhubh)}(h,.. |sung| unicode:: U+0266A .. EIGHTH NOTEh]h♪}hjsbah}(h]h ]h"]sungah$]h&]uh1hhhhKJhhhhubh)}(h0.. |sup1| unicode:: U+000B9 .. SUPERSCRIPT ONEh]h¹}hjsbah}(h]h ]h"]sup1ah$]h&]uh1hhhhKKhhhhubh)}(h0.. |sup2| unicode:: U+000B2 .. SUPERSCRIPT TWOh]h²}hjsbah}(h]h ]h"]sup2ah$]h&]uh1hhhhKLhhhhubh)}(h2.. |sup3| unicode:: U+000B3 .. SUPERSCRIPT THREEh]h³}hjsbah}(h]h ]h"]sup3ah$]h&]uh1hhhhKMhhhhubh)}(h4.. |times| unicode:: U+000D7 .. MULTIPLICATION SIGNh]h×}hjsbah}(h]h ]h"]timesah$]h&]uh1hhhhKNhhhhubh)}(h0.. |trade| unicode:: U+02122 .. TRADE MARK SIGNh]h™}hj sbah}(h]h ]h"]tradeah$]h&]uh1hhhhKOhhhhubh)}(h... |uarr| unicode:: U+02191 .. UPWARDS ARROWh]h↑}hjsbah}(h]h ]h"]uarrah$]h&]uh1hhhhKPhhhhubh)}(h... |verbar| unicode:: U+0007C .. VERTICAL LINEh]h|}hj)sbah}(h]h ]h"]verbarah$]h&]uh1hhhhKQhhhhubh)}(h*.. |yen| unicode:: U+000A5 .. YEN SIGN h]h¥}hj8sbah}(h]h ]h"]yenah$]h&]uh1hhhhKRhhhhubhsection)}(hhh](htitle)}(hUsing Linux CAIFh]hUsing Linux CAIF}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1jLhjIhhhhhKubh field_list)}(hhh](hfield)}(hhh](h field_name)}(h Copyrighth]h Copyright}(hjhhhhNhNubah}(h]h ]h"]h$]h&]uh1jfhjchhhKubh field_body)}(h|copy| ST-Ericsson AB 2010 h]h paragraph)}(h|copy| ST-Ericsson AB 2010h](h©}(hj~hhhNhNubh ST-Ericsson AB 2010}(hj~hhhNhNubeh}(h]h ]h"]h$]h&]uh1j|hhhK hjxubah}(h]h ]h"]h$]h&]uh1jvhjcubeh}(h]h ]h"]h$]h&]uh1jahhhK hj^hhubjb)}(hhh](jg)}(hAuthorh]hAuthor}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jfhjhhhKubjw)}(h0Sjur Brendeland/ sjur.brandeland@stericsson.com h]j})}(h/Sjur Brendeland/ sjur.brandeland@stericsson.comh](hSjur Brendeland/ }(hjhhhNhNubh reference)}(hsjur.brandeland@stericsson.comh]hsjur.brandeland@stericsson.com}(hjhhhNhNubah}(h]h ]h"]h$]h&]refuri%mailto:sjur.brandeland@stericsson.comuh1jhjubeh}(h]h ]h"]h$]h&]uh1j|hhhK hjubah}(h]h ]h"]h$]h&]uh1jvhjubeh}(h]h ]h"]h$]h&]uh1jahhhK hj^hhubeh}(h]h ]h"]h$]h&]uh1j\hjIhhhhhK ubjH)}(hhh](jM)}(hStarth]hStart}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jLhjhhhhhKubj})}(h*If you have compiled CAIF for modules do::h]h)If you have compiled CAIF for modules do:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhjhhubh literal_block)}(hK$modprobe crc_ccitt $modprobe caif $modprobe caif_socket $modprobe chnl_neth]hK$modprobe crc_ccitt $modprobe caif $modprobe caif_socket $modprobe chnl_net}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhKhjhhubeh}(h]startah ]h"]startah$]h&]uh1jGhjIhhhhhKubjH)}(hhh](jM)}(h$Preparing the setup with a STE modemh]h$Preparing the setup with a STE modem}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jLhjhhhhhKubj})}(hlIf you are working on integration of CAIF you should make sure that the kernel is built with module support.h]hlIf you are working on integration of CAIF you should make sure that the kernel is built with module support.}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhjhhubj})}(hXThere are some things that need to be tweaked to get the host TTY correctly set up to talk to the modem. Since the CAIF stack is running in the kernel and we want to use the existing TTY, we are installing our physical serial driver as a line discipline above the TTY device.h]hXThere are some things that need to be tweaked to get the host TTY correctly set up to talk to the modem. Since the CAIF stack is running in the kernel and we want to use the existing TTY, we are installing our physical serial driver as a line discipline above the TTY device.}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhjhhubj})}(hsTo achieve this we need to install the N_CAIF ldisc from user space. The benefit is that we can hook up to any TTY.h]hsTo achieve this we need to install the N_CAIF ldisc from user space. The benefit is that we can hook up to any TTY.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK%hjhhubj})}(h]The use of Start-of-frame-extension (STX) must also be set as module parameter "ser_use_stx".h]haThe use of Start-of-frame-extension (STX) must also be set as module parameter “ser_use_stx”.}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK(hjhhubj})}(hnNormally Frame Checksum is always used on UART, but this is also provided as a module parameter "ser_use_fcs".h]hrNormally Frame Checksum is always used on UART, but this is also provided as a module parameter “ser_use_fcs”.}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK+hjhhubj)}(hV$ modprobe caif_serial ser_ttyname=/dev/ttyS0 ser_use_stx=yes $ ifconfig caif_ttyS0 uph]hV$ modprobe caif_serial ser_ttyname=/dev/ttyS0 ser_use_stx=yes $ ifconfig caif_ttyS0 up}hjqsbah}(h]h ]h"]h$]h&]hhuh1jhhhK0hjhhubhdefinition_list)}(hhh]hdefinition_list_item)}(hfPLEASE NOTE: There is a limitation in Android shell. It only accepts one argument to insmod/modprobe! h](hterm)}(h PLEASE NOTE:h]h PLEASE NOTE:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhK5hjubh definition)}(hhh]j})}(hXThere is a limitation in Android shell. It only accepts one argument to insmod/modprobe!h]hXThere is a limitation in Android shell. It only accepts one argument to insmod/modprobe!}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK4hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhK5hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h]$preparing-the-setup-with-a-ste-modemah ]h"]$preparing the setup with a ste modemah$]h&]uh1jGhjIhhhhhKubjH)}(hhh](jM)}(hTrouble shootingh]hTrouble shooting}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jLhjhhhhhK8ubj})}(hiThere are debugfs parameters provided for serial communication. /sys/kernel/debug/caif_serial//h]hiThere are debugfs parameters provided for serial communication. /sys/kernel/debug/caif_serial//}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK:hjhhubh bullet_list)}(hhh](h list_item)}(hXser_state: Prints the bit-mask status where - 0x02 means SENDING, this is a transient state. - 0x10 means FLOW_OFF_SENT, i.e. the previous frame has not been sent and is blocking further send operation. Flow OFF has been propagated to all CAIF Channels using this TTY. h](j})}(h-ser_state: Prints the bit-mask status whereh]h-ser_state: Prints the bit-mask status where}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK=hjubj)}(hhh](j)}(h.0x02 means SENDING, this is a transient state.h]j})}(hjh]h.0x02 means SENDING, this is a transient state.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK?hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(h0x10 means FLOW_OFF_SENT, i.e. the previous frame has not been sent and is blocking further send operation. Flow OFF has been propagated to all CAIF Channels using this TTY. h]j})}(h0x10 means FLOW_OFF_SENT, i.e. the previous frame has not been sent and is blocking further send operation. Flow OFF has been propagated to all CAIF Channels using this TTY.h]h0x10 means FLOW_OFF_SENT, i.e. the previous frame has not been sent and is blocking further send operation. Flow OFF has been propagated to all CAIF Channels using this TTY.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK@hjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]bullet-uh1jhhhK?hjubeh}(h]h ]h"]h$]h&]uh1jhjhhhNhNubj)}(htty_status: Prints the bit-mask tty status information - 0x01 - tty->warned is on. - 0x04 - tty->packed is on. - 0x08 - tty->flow.tco_stopped is on. - 0x10 - tty->hw_stopped is on. - 0x20 - tty->flow.stopped is on. h](j})}(h6tty_status: Prints the bit-mask tty status informationh]h6tty_status: Prints the bit-mask tty status information}(hjChhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKDhj?ubj)}(hhh](j)}(h0x01 - tty->warned is on.h]j})}(hjVh]h0x01 - tty->warned is on.}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKFhjTubah}(h]h ]h"]h$]h&]uh1jhjQubj)}(h0x04 - tty->packed is on.h]j})}(hjmh]h0x04 - tty->packed is on.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKGhjkubah}(h]h ]h"]h$]h&]uh1jhjQubj)}(h#0x08 - tty->flow.tco_stopped is on.h]j})}(hjh]h#0x08 - tty->flow.tco_stopped is on.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKHhjubah}(h]h ]h"]h$]h&]uh1jhjQubj)}(h0x10 - tty->hw_stopped is on.h]j})}(hjh]h0x10 - tty->hw_stopped is on.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKIhjubah}(h]h ]h"]h$]h&]uh1jhjQubj)}(h 0x20 - tty->flow.stopped is on. h]j})}(h0x20 - tty->flow.stopped is on.h]h0x20 - tty->flow.stopped is on.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKJhjubah}(h]h ]h"]h$]h&]uh1jhjQubeh}(h]h ]h"]h$]h&]j7j8uh1jhhhKFhj?ubeh}(h]h ]h"]h$]h&]uh1jhjhhhNhNubj)}(hXjlast_tx_msg: Binary blob Prints the last transmitted frame. This can be printed with:: $od --format=x1 /sys/kernel/debug/caif_serial//last_rx_msg. The first two tx messages sent look like this. Note: The initial byte 02 is start of frame extension (STX) used for re-syncing upon errors. - Enumeration:: 0000000 02 05 00 00 03 01 d2 02 | | | | | | STX(1) | | | | Length(2)| | | Control Channel(1) Command:Enumeration(1) Link-ID(1) Checksum(2) - Channel Setup:: 0000000 02 07 00 00 00 21 a1 00 48 df | | | | | | | | STX(1) | | | | | | Length(2)| | | | | Control Channel(1) Command:Channel Setup(1) Channel Type(1) Priority and Link-ID(1) Endpoint(1) Checksum(2) h](j})}(h;last_tx_msg: Binary blob Prints the last transmitted frame.h]h;last_tx_msg: Binary blob Prints the last transmitted frame.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKLhjubj})}(hThis can be printed with::h]hThis can be printed with:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKNhjubj)}(h@$od --format=x1 /sys/kernel/debug/caif_serial//last_rx_msg.h]h@$od --format=x1 /sys/kernel/debug/caif_serial//last_rx_msg.}hjsbah}(h]h ]h"]h$]h&]hhuh1jhhhKPhjubj})}(hThe first two tx messages sent look like this. Note: The initial byte 02 is start of frame extension (STX) used for re-syncing upon errors.h]hThe first two tx messages sent look like this. Note: The initial byte 02 is start of frame extension (STX) used for re-syncing upon errors.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKRhjubj)}(hhh](j)}(hXCEnumeration:: 0000000 02 05 00 00 03 01 d2 02 | | | | | | STX(1) | | | | Length(2)| | | Control Channel(1) Command:Enumeration(1) Link-ID(1) Checksum(2) h](j})}(h Enumeration::h]h Enumeration:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKVhjubj)}(hX0000000 02 05 00 00 03 01 d2 02 | | | | | | STX(1) | | | | Length(2)| | | Control Channel(1) Command:Enumeration(1) Link-ID(1) Checksum(2)h]hX0000000 02 05 00 00 03 01 d2 02 | | | | | | STX(1) | | | | Length(2)| | | Control Channel(1) Command:Enumeration(1) Link-ID(1) Checksum(2)}hj%sbah}(h]h ]h"]h$]h&]hhuh1jhhhKXhjubeh}(h]h ]h"]h$]h&]uh1jhjubj)}(hXChannel Setup:: 0000000 02 07 00 00 00 21 a1 00 48 df | | | | | | | | STX(1) | | | | | | Length(2)| | | | | Control Channel(1) Command:Channel Setup(1) Channel Type(1) Priority and Link-ID(1) Endpoint(1) Checksum(2) h](j})}(hChannel Setup::h]hChannel Setup:}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKahj9ubj)}(hX0000000 02 07 00 00 00 21 a1 00 48 df | | | | | | | | STX(1) | | | | | | Length(2)| | | | | Control Channel(1) Command:Channel Setup(1) Channel Type(1) Priority and Link-ID(1) Endpoint(1) Checksum(2)h]hX0000000 02 07 00 00 00 21 a1 00 48 df | | | | | | | | STX(1) | | | | | | Length(2)| | | | | Control Channel(1) Command:Channel Setup(1) Channel Type(1) Priority and Link-ID(1) Endpoint(1) Checksum(2)}hjKsbah}(h]h ]h"]h$]h&]hhuh1jhhhKchj9ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]j7j8uh1jhhhKVhjubeh}(h]h ]h"]h$]h&]uh1jhjhhhNhNubj)}(hXPlast_rx_msg: Prints the last transmitted frame. The RX messages for LinkSetup look almost identical but they have the bit 0x20 set in the command bit, and Channel Setup has added one byte before Checksum containing Channel ID. NOTE: Several CAIF Messages might be concatenated. The maximum debug buffer size is 128 bytes. h](j})}(h/last_rx_msg: Prints the last transmitted frame.h]h/last_rx_msg: Prints the last transmitted frame.}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKnhjkubj})}(hThe RX messages for LinkSetup look almost identical but they have the bit 0x20 set in the command bit, and Channel Setup has added one byte before Checksum containing Channel ID.h]hThe RX messages for LinkSetup look almost identical but they have the bit 0x20 set in the command bit, and Channel Setup has added one byte before Checksum containing Channel ID.}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKphjkubj)}(hhh]j)}(h_NOTE: Several CAIF Messages might be concatenated. The maximum debug buffer size is 128 bytes. h](j)}(hNOTE:h]hNOTE:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhhhKvhjubj)}(hhh]j})}(hXSeveral CAIF Messages might be concatenated. The maximum debug buffer size is 128 bytes.h]hXSeveral CAIF Messages might be concatenated. The maximum debug buffer size is 128 bytes.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKuhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhKvhjubah}(h]h ]h"]h$]h&]uh1jhjkubeh}(h]h ]h"]h$]h&]uh1jhjhhhNhNubeh}(h]h ]h"]h$]h&]j7*uh1jhhhK=hjhhubeh}(h]trouble-shootingah ]h"]trouble shootingah$]h&]uh1jGhjIhhhhhK8ubjH)}(hhh](jM)}(hError Scenariosh]hError Scenarios}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jLhjhhhhhKyubj)}(hhh](j)}(hlast_tx_msg contains channel setup message and last_rx_msg is empty -> The host seems to be able to send over the UART, at least the CAIF ldisc get notified that sending is completed. h]j})}(hlast_tx_msg contains channel setup message and last_rx_msg is empty -> The host seems to be able to send over the UART, at least the CAIF ldisc get notified that sending is completed.h]hlast_tx_msg contains channel setup message and last_rx_msg is empty -> The host seems to be able to send over the UART, at least the CAIF ldisc get notified that sending is completed.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhK{hjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hlast_tx_msg contains enumeration message and last_rx_msg is empty -> The host is not able to send the message from UART, the tty has not been able to complete the transmit operation. h]j})}(hlast_tx_msg contains enumeration message and last_rx_msg is empty -> The host is not able to send the message from UART, the tty has not been able to complete the transmit operation.h]hlast_tx_msg contains enumeration message and last_rx_msg is empty -> The host is not able to send the message from UART, the tty has not been able to complete the transmit operation.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhj ubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubj)}(hXQif /sys/kernel/debug/caif_serial//tty_status is non-zero there might be problems transmitting over UART. E.g. host and modem wiring is not correct you will typically see tty_status = 0x10 (hw_stopped) and ser_state = 0x10 (FLOW_OFF_SENT). You will probably see the enumeration message in last_tx_message and empty last_rx_message.h](j})}(hmif /sys/kernel/debug/caif_serial//tty_status is non-zero there might be problems transmitting over UART.h]hmif /sys/kernel/debug/caif_serial//tty_status is non-zero there might be problems transmitting over UART.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhj ubj})}(hE.g. host and modem wiring is not correct you will typically see tty_status = 0x10 (hw_stopped) and ser_state = 0x10 (FLOW_OFF_SENT).h]hE.g. host and modem wiring is not correct you will typically see tty_status = 0x10 (hw_stopped) and ser_state = 0x10 (FLOW_OFF_SENT).}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhj ubj})}(h[You will probably see the enumeration message in last_tx_message and empty last_rx_message.h]h[You will probably see the enumeration message in last_tx_message and empty last_rx_message.}(hj< hhhNhNubah}(h]h ]h"]h$]h&]uh1j|hhhKhj ubeh}(h]h ]h"]h$]h&]uh1jhjhhhhhNubeh}(h]h ]h"]h$]h&]j7j8uh1jhhhK{hjhhubeh}(h]error-scenariosah ]h"]error scenariosah$]h&]uh1jGhjIhhhhhKyubeh}(h]using-linux-caifah ]h"]using linux caifah$]h&]uh1jGhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(jLN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}(hhhhhhj jjjj*jj9j-jHj<jWjKjfjZjujijjxjjjjjjjjjjjjjjjjj jjjj)jj8j,jGj;jVjJjejYjtjhjjwjjjjjjjjjjjjjjjjj jjj j(jj7j+jFj:jUjIjdjXjsjgjjvjjjjjjjjjjjjjjjjj jjj j'jj6j*jEj9jTjHjcjWjrjfjjujjjjjjjjjjjjjjjjjjjj j&jj5j)jDj8usubstitution_names}(amphߌaposhasthbrvbarj bsoljcentj*colonj9commajHcommatjWcopyjfcurrenjudarrjdegjdividejdollarjequalsjexcljfrac12jfrac14jfrac18jfrac34j frac38jfrac58j)frac78j8gtjGhalfjVhorbarjehyphenjtiexcljiquestjlaquojlarrjlcubjldquojlowbarjlparjlsqbjlsquoj ltjmicroj(middotj7nbspjFnotjUnumjdohmjsordfjordmjparajpercntjperiodjplusjplusmnjpoundjquestjquotj raquojrarrj'rcubj6rdquojEregjTrparjcrsqbjrrsquojsectjsemijshyjsoljsungjsup1jsup2jsup3jtimesjtradejuarrj&verbarj5yenjDurefnames}refids}nameids}(jc j` jjjjjjj[ jX u nametypes}(jc jjjj[ uh}(j` jIjjjjjjjX ju 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]&Documentation/networking/caif/caif.rst(NNNNta decorationNhhub.