€•6|      Œsphinx.addnodes”Œdocument”“”)”}”(Œ	rawsource”Œ ”Œchildren”]”(Œtranslations”ŒLanguagesNode”“”)”}”(hhh]”(h Œpending_xref”“”)”}”(hhh]”Œdocutils.nodes”ŒText”“”ŒChinese (Simplified)”…””}”Œparent”hsbaŒ
attributes”}”(Œids”]”Œclasses”]”Œnames”]”Œdupnames”]”Œbackrefs”]”Œ	refdomain”Œstd”Œreftype”Œdoc”Œ	reftarget”Œ:/translations/zh_CN/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuŒtagname”hhhubh)”}”(hhh]”hŒChinese (Traditional)”…””}”hh2sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ:/translations/zh_TW/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒItalian”…””}”hhFsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ:/translations/it_IT/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒJapanese”…””}”hhZsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ:/translations/ja_JP/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒKorean”…””}”hhnsbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ:/translations/ko_KR/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒPortuguese (Brazilian)”…””}”hh‚sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ:/translations/pt_BR/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubh)”}”(hhh]”hŒSpanish”…””}”hh–sbah}”(h]”h ]”h"]”h$]”h&]”Œ	refdomain”h)Œreftype”h+Œ	reftarget”Œ:/translations/sp_SP/watchdog/convert_drivers_to_kernel_api”Œmodname”NŒ	classname”NŒrefexplicit”ˆuh1hhhubeh}”(h]”h ]”h"]”h$]”h&]”Œcurrent_language”ŒEnglish”uh1h
hhŒ	_document”hŒsource”NŒline”NubhŒsection”“”)”}”(hhh]”(hŒtitle”“”)”}”(hŒ9Converting old watchdog drivers to the watchdog framework”h]”hŒ9Converting old watchdog drivers to the watchdog framework”…””}”(hh¼h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhh·h²hh³ŒT/var/lib/git/docbuild/linux/Documentation/watchdog/convert_drivers_to_kernel_api.rst”h´KubhŒ	paragraph”“”)”}”(hŒ by Wolfram Sang <wsa@kernel.org>”h]”(hŒby Wolfram Sang <”…””}”(hhÍh²hh³Nh´NubhŒ	reference”“”)”}”(hŒwsa@kernel.org”h]”hŒwsa@kernel.org”…””}”(hh×h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œmailto:wsa@kernel.org”uh1hÕhhÍubhŒ>”…””}”(hhÍh²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubhÌ)”}”(hXS  Before the watchdog framework came into the kernel, every driver had to
implement the API on its own. Now, as the framework factored out the common
components, those drivers can be lightened making it a user of the framework.
This document shall guide you for this task. The necessary steps are described
as well as things to look out for.”h]”hXS  Before the watchdog framework came into the kernel, every driver had to
implement the API on its own. Now, as the framework factored out the common
components, those drivers can be lightened making it a user of the framework.
This document shall guide you for this task. The necessary steps are described
as well as things to look out for.”…””}”(hhñh²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khh·h²hubh¶)”}”(hhh]”(h»)”}”(hŒ!Remove the file_operations struct”h]”hŒ!Remove the file_operations struct”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhhÿh²hh³hÊh´KubhÌ)”}”(hXz  Old drivers define their own file_operations for actions like open(), write(),
etc... These are now handled by the framework and just call the driver when
needed. So, in general, the 'file_operations' struct and assorted functions can
go. Only very few driver-specific details have to be moved to other functions.
Here is a overview of the functions and probably needed actions:”h]”hX~  Old drivers define their own file_operations for actions like open(), write(),
etc... These are now handled by the framework and just call the driver when
needed. So, in general, the â€˜file_operationsâ€™ struct and assorted functions can
go. Only very few driver-specific details have to be moved to other functions.
Here is a overview of the functions and probably needed actions:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khhÿh²hubhŒbullet_list”“”)”}”(hhh]”(hŒ	list_item”“”)”}”(hXˆ  open: Everything dealing with resource management (file-open checks, magic
close preparations) can simply go. Device specific stuff needs to go to the
driver specific start-function. Note that for some drivers, the start-function
also serves as the ping-function. If that is the case and you need start/stop
to be balanced (clocks!), you are better off refactoring a separate start-function.
”h]”hÌ)”}”(hX‡  open: Everything dealing with resource management (file-open checks, magic
close preparations) can simply go. Device specific stuff needs to go to the
driver specific start-function. Note that for some drivers, the start-function
also serves as the ping-function. If that is the case and you need start/stop
to be balanced (clocks!), you are better off refactoring a separate start-function.”h]”hX‡  open: Everything dealing with resource management (file-open checks, magic
close preparations) can simply go. Device specific stuff needs to go to the
driver specific start-function. Note that for some drivers, the start-function
also serves as the ping-function. If that is the case and you need start/stop
to be balanced (clocks!), you are better off refactoring a separate start-function.”…””}”(hj)  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khj%  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j#  hj   h²hh³hÊh´Nubj$  )”}”(hŒ%close: Same hints as for open apply.
”h]”hÌ)”}”(hŒ$close: Same hints as for open apply.”h]”hŒ$close: Same hints as for open apply.”…””}”(hjA  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Khj=  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j#  hj   h²hh³hÊh´Nubj$  )”}”(hŒwrite: Can simply go, all defined behaviour is taken care of by the framework,
i.e. ping on write and magic char ('V') handling.
”h]”hÌ)”}”(hŒ€write: Can simply go, all defined behaviour is taken care of by the framework,
i.e. ping on write and magic char ('V') handling.”h]”hŒ„write: Can simply go, all defined behaviour is taken care of by the framework,
i.e. ping on write and magic char (â€˜Vâ€™) handling.”…””}”(hjY  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KhjU  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j#  hj   h²hh³hÊh´Nubj$  )”}”(hX  ioctl: While the driver is allowed to have extensions to the IOCTL interface,
the most common ones are handled by the framework, supported by some assistance
from the driver:

      WDIOC_GETSUPPORT:
              Returns the mandatory watchdog_info struct from the driver

      WDIOC_GETSTATUS:
              Needs the status-callback defined, otherwise returns 0

      WDIOC_GETBOOTSTATUS:
              Needs the bootstatus member properly set. Make sure it is 0 if you
              don't have further support!

      WDIOC_SETOPTIONS:
              No preparations needed

      WDIOC_KEEPALIVE:
              If wanted, options in watchdog_info need to have WDIOF_KEEPALIVEPING
              set

      WDIOC_SETTIMEOUT:
              Options in watchdog_info need to have WDIOF_SETTIMEOUT set
              and a set_timeout-callback has to be defined. The core will also
              do limit-checking, if min_timeout and max_timeout in the watchdog
              device are set. All is optional.

      WDIOC_GETTIMEOUT:
              No preparations needed

      WDIOC_GETTIMELEFT:
              It needs get_timeleft() callback to be defined. Otherwise it
              will return EOPNOTSUPP

Other IOCTLs can be served using the ioctl-callback. Note that this is mainly
intended for porting old drivers; new drivers should not invent private IOCTLs.
Private IOCTLs are processed first. When the callback returns with
-ENOIOCTLCMD, the IOCTLs of the framework will be tried, too. Any other error
is directly given to the user.
”h]”(hÌ)”}”(hŒ®ioctl: While the driver is allowed to have extensions to the IOCTL interface,
the most common ones are handled by the framework, supported by some assistance
from the driver:”h]”hŒ®ioctl: While the driver is allowed to have extensions to the IOCTL interface,
the most common ones are handled by the framework, supported by some assistance
from the driver:”…””}”(hjq  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K"hjm  ubhŒblock_quote”“”)”}”(hX„  WDIOC_GETSUPPORT:
        Returns the mandatory watchdog_info struct from the driver

WDIOC_GETSTATUS:
        Needs the status-callback defined, otherwise returns 0

WDIOC_GETBOOTSTATUS:
        Needs the bootstatus member properly set. Make sure it is 0 if you
        don't have further support!

WDIOC_SETOPTIONS:
        No preparations needed

WDIOC_KEEPALIVE:
        If wanted, options in watchdog_info need to have WDIOF_KEEPALIVEPING
        set

WDIOC_SETTIMEOUT:
        Options in watchdog_info need to have WDIOF_SETTIMEOUT set
        and a set_timeout-callback has to be defined. The core will also
        do limit-checking, if min_timeout and max_timeout in the watchdog
        device are set. All is optional.

WDIOC_GETTIMEOUT:
        No preparations needed

WDIOC_GETTIMELEFT:
        It needs get_timeleft() callback to be defined. Otherwise it
        will return EOPNOTSUPP
”h]”hŒdefinition_list”“”)”}”(hhh]”(hŒdefinition_list_item”“”)”}”(hŒMWDIOC_GETSUPPORT:
Returns the mandatory watchdog_info struct from the driver
”h]”(hŒterm”“”)”}”(hŒWDIOC_GETSUPPORT:”h]”hŒWDIOC_GETSUPPORT:”…””}”(hj’  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K'hjŒ  ubhŒ
definition”“”)”}”(hhh]”hÌ)”}”(hŒ:Returns the mandatory watchdog_info struct from the driver”h]”hŒ:Returns the mandatory watchdog_info struct from the driver”…””}”(hj¥  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K'hj¢  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hjŒ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K'hj‡  ubj‹  )”}”(hŒHWDIOC_GETSTATUS:
Needs the status-callback defined, otherwise returns 0
”h]”(j‘  )”}”(hŒWDIOC_GETSTATUS:”h]”hŒWDIOC_GETSTATUS:”…””}”(hjÃ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K*hj¿  ubj¡  )”}”(hhh]”hÌ)”}”(hŒ6Needs the status-callback defined, otherwise returns 0”h]”hŒ6Needs the status-callback defined, otherwise returns 0”…””}”(hjÔ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K*hjÑ  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hj¿  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K*hj‡  ubj‹  )”}”(hŒtWDIOC_GETBOOTSTATUS:
Needs the bootstatus member properly set. Make sure it is 0 if you
don't have further support!
”h]”(j‘  )”}”(hŒWDIOC_GETBOOTSTATUS:”h]”hŒWDIOC_GETBOOTSTATUS:”…””}”(hjò  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K.hjî  ubj¡  )”}”(hhh]”hÌ)”}”(hŒ^Needs the bootstatus member properly set. Make sure it is 0 if you
don't have further support!”h]”hŒ`Needs the bootstatus member properly set. Make sure it is 0 if you
donâ€™t have further support!”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K-hj   ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hjî  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K.hj‡  ubj‹  )”}”(hŒ)WDIOC_SETOPTIONS:
No preparations needed
”h]”(j‘  )”}”(hŒWDIOC_SETOPTIONS:”h]”hŒWDIOC_SETOPTIONS:”…””}”(hj!  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K1hj  ubj¡  )”}”(hhh]”hÌ)”}”(hŒNo preparations needed”h]”hŒNo preparations needed”…””}”(hj2  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K1hj/  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hj  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K1hj‡  ubj‹  )”}”(hŒZWDIOC_KEEPALIVE:
If wanted, options in watchdog_info need to have WDIOF_KEEPALIVEPING
set
”h]”(j‘  )”}”(hŒWDIOC_KEEPALIVE:”h]”hŒWDIOC_KEEPALIVE:”…””}”(hjP  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K5hjL  ubj¡  )”}”(hhh]”hÌ)”}”(hŒHIf wanted, options in watchdog_info need to have WDIOF_KEEPALIVEPING
set”h]”hŒHIf wanted, options in watchdog_info need to have WDIOF_KEEPALIVEPING
set”…””}”(hja  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K4hj^  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hjL  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K5hj‡  ubj‹  )”}”(hŒñWDIOC_SETTIMEOUT:
Options in watchdog_info need to have WDIOF_SETTIMEOUT set
and a set_timeout-callback has to be defined. The core will also
do limit-checking, if min_timeout and max_timeout in the watchdog
device are set. All is optional.
”h]”(j‘  )”}”(hŒWDIOC_SETTIMEOUT:”h]”hŒWDIOC_SETTIMEOUT:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K;hj{  ubj¡  )”}”(hhh]”hÌ)”}”(hŒÞOptions in watchdog_info need to have WDIOF_SETTIMEOUT set
and a set_timeout-callback has to be defined. The core will also
do limit-checking, if min_timeout and max_timeout in the watchdog
device are set. All is optional.”h]”hŒÞOptions in watchdog_info need to have WDIOF_SETTIMEOUT set
and a set_timeout-callback has to be defined. The core will also
do limit-checking, if min_timeout and max_timeout in the watchdog
device are set. All is optional.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K8hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hj{  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K;hj‡  ubj‹  )”}”(hŒ)WDIOC_GETTIMEOUT:
No preparations needed
”h]”(j‘  )”}”(hŒWDIOC_GETTIMEOUT:”h]”hŒWDIOC_GETTIMEOUT:”…””}”(hj®  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K>hjª  ubj¡  )”}”(hhh]”hÌ)”}”(hŒNo preparations needed”h]”hŒNo preparations needed”…””}”(hj¿  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K>hj¼  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hjª  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´K>hj‡  ubj‹  )”}”(hŒgWDIOC_GETTIMELEFT:
It needs get_timeleft() callback to be defined. Otherwise it
will return EOPNOTSUPP
”h]”(j‘  )”}”(hŒWDIOC_GETTIMELEFT:”h]”hŒWDIOC_GETTIMELEFT:”…””}”(hjÝ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´KBhjÙ  ubj¡  )”}”(hhh]”hÌ)”}”(hŒSIt needs get_timeleft() callback to be defined. Otherwise it
will return EOPNOTSUPP”h]”hŒSIt needs get_timeleft() callback to be defined. Otherwise it
will return EOPNOTSUPP”…””}”(hjî  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KAhjë  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j   hjÙ  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1jŠ  h³hÊh´KBhj‡  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j…  hj  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´K&hjm  ubhÌ)”}”(hXM  Other IOCTLs can be served using the ioctl-callback. Note that this is mainly
intended for porting old drivers; new drivers should not invent private IOCTLs.
Private IOCTLs are processed first. When the callback returns with
-ENOIOCTLCMD, the IOCTLs of the framework will be tried, too. Any other error
is directly given to the user.”h]”hXM  Other IOCTLs can be served using the ioctl-callback. Note that this is mainly
intended for porting old drivers; new drivers should not invent private IOCTLs.
Private IOCTLs are processed first. When the callback returns with
-ENOIOCTLCMD, the IOCTLs of the framework will be tried, too. Any other error
is directly given to the user.”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KDhjm  ubeh}”(h]”h ]”h"]”h$]”h&]”uh1j#  hj   h²hh³hÊh´Nubeh}”(h]”h ]”h"]”h$]”h&]”Œbullet”Œ-”uh1j  h³hÊh´Khhÿh²hubhÌ)”}”(hŒExample conversion::”h]”hŒExample conversion:”…””}”(hj0  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KJhhÿh²hubhŒliteral_block”“”)”}”(hX  -static const struct file_operations s3c2410wdt_fops = {
-       .owner          = THIS_MODULE,
-       .write          = s3c2410wdt_write,
-       .unlocked_ioctl = s3c2410wdt_ioctl,
-       .open           = s3c2410wdt_open,
-       .release        = s3c2410wdt_release,
-};”h]”hX  -static const struct file_operations s3c2410wdt_fops = {
-       .owner          = THIS_MODULE,
-       .write          = s3c2410wdt_write,
-       .unlocked_ioctl = s3c2410wdt_ioctl,
-       .open           = s3c2410wdt_open,
-       .release        = s3c2410wdt_release,
-};”…””}”hj@  sbah}”(h]”h ]”h"]”h$]”h&]”Œ	xml:space”Œpreserve”uh1j>  h³hÊh´KLhhÿh²hubhÌ)”}”(hŒaCheck the functions for device-specific stuff and keep it for later
refactoring. The rest can go.”h]”hŒaCheck the functions for device-specific stuff and keep it for later
refactoring. The rest can go.”…””}”(hjP  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KThhÿh²hubeh}”(h]”Œ!remove-the-file-operations-struct”ah ]”h"]”Œ!remove the file_operations struct”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kubh¶)”}”(hhh]”(h»)”}”(hŒRemove the miscdevice”h]”hŒRemove the miscdevice”…””}”(hji  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjf  h²hh³hÊh´KYubhÌ)”}”(hŒ³Since the file_operations are gone now, you can also remove the 'struct
miscdevice'. The framework will create it on watchdog_dev_register() called by
watchdog_register_device()::”h]”hŒ¶Since the file_operations are gone now, you can also remove the â€˜struct
miscdeviceâ€™. The framework will create it on watchdog_dev_register() called by
watchdog_register_device():”…””}”(hjw  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K[hjf  h²hubj?  )”}”(hŒ°-static struct miscdevice s3c2410wdt_miscdev = {
-       .minor          = WATCHDOG_MINOR,
-       .name           = "watchdog",
-       .fops           = &s3c2410wdt_fops,
-};”h]”hŒ°-static struct miscdevice s3c2410wdt_miscdev = {
-       .minor          = WATCHDOG_MINOR,
-       .name           = "watchdog",
-       .fops           = &s3c2410wdt_fops,
-};”…””}”hj…  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´K_hjf  h²hubeh}”(h]”Œremove-the-miscdevice”ah ]”h"]”Œremove the miscdevice”ah$]”h&]”uh1hµhh·h²hh³hÊh´KYubh¶)”}”(hhh]”(h»)”}”(hŒ$Remove obsolete includes and defines”h]”hŒ$Remove obsolete includes and defines”…””}”(hjž  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj›  h²hh³hÊh´KgubhÌ)”}”(hŒBecause of the simplifications, a few defines are probably unused now. Remove
them. Includes can be removed, too. For example::”h]”hŒ~Because of the simplifications, a few defines are probably unused now. Remove
them. Includes can be removed, too. For example:”…””}”(hj¬  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kihj›  h²hubj?  )”}”(hŒ™- #include <linux/fs.h>
- #include <linux/miscdevice.h> (if MODULE_ALIAS_MISCDEV is not used)
- #include <linux/uaccess.h> (if no custom IOCTLs are used)”h]”hŒ™- #include <linux/fs.h>
- #include <linux/miscdevice.h> (if MODULE_ALIAS_MISCDEV is not used)
- #include <linux/uaccess.h> (if no custom IOCTLs are used)”…””}”hjº  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´Klhj›  h²hubeh}”(h]”Œ$remove-obsolete-includes-and-defines”ah ]”h"]”Œ$remove obsolete includes and defines”ah$]”h&]”uh1hµhh·h²hh³hÊh´Kgubh¶)”}”(hhh]”(h»)”}”(hŒAdd the watchdog operations”h]”hŒAdd the watchdog operations”…””}”(hjÓ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÐ  h²hh³hÊh´KrubhÌ)”}”(hX[  All possible callbacks are defined in 'struct watchdog_ops'. You can find it
explained in 'watchdog-kernel-api.txt' in this directory. start() and
owner must be set, the rest are optional. You will easily find corresponding
functions in the old driver. Note that you will now get a pointer to the
watchdog_device as a parameter to these functions, so you probably have to
change the function header. Other changes are most likely not needed, because
here simply happens the direct hardware access. If you have device-specific
code left from the above steps, it should be refactored into these callbacks.”h]”hXc  All possible callbacks are defined in â€˜struct watchdog_opsâ€™. You can find it
explained in â€˜watchdog-kernel-api.txtâ€™ in this directory. start() and
owner must be set, the rest are optional. You will easily find corresponding
functions in the old driver. Note that you will now get a pointer to the
watchdog_device as a parameter to these functions, so you probably have to
change the function header. Other changes are most likely not needed, because
here simply happens the direct hardware access. If you have device-specific
code left from the above steps, it should be refactored into these callbacks.”…””}”(hjá  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KthjÐ  h²hubhÌ)”}”(hŒHere is a simple example::”h]”hŒHere is a simple example:”…””}”(hjï  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K}hjÐ  h²hubj?  )”}”(hŒë+static struct watchdog_ops s3c2410wdt_ops = {
+       .owner = THIS_MODULE,
+       .start = s3c2410wdt_start,
+       .stop = s3c2410wdt_stop,
+       .ping = s3c2410wdt_keepalive,
+       .set_timeout = s3c2410wdt_set_heartbeat,
+};”h]”hŒë+static struct watchdog_ops s3c2410wdt_ops = {
+       .owner = THIS_MODULE,
+       .start = s3c2410wdt_start,
+       .stop = s3c2410wdt_stop,
+       .ping = s3c2410wdt_keepalive,
+       .set_timeout = s3c2410wdt_set_heartbeat,
+};”…””}”hjý  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´KhjÐ  h²hubhÌ)”}”(hŒ-A typical function-header change looks like::”h]”hŒ,A typical function-header change looks like:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K‡hjÐ  h²hubj?  )”}”(hŒÕ-static void s3c2410wdt_keepalive(void)
+static int s3c2410wdt_keepalive(struct watchdog_device *wdd)
 {
...
+
+       return 0;
 }

...

-       s3c2410wdt_keepalive();
+       s3c2410wdt_keepalive(&s3c2410_wdd);”h]”hŒÕ-static void s3c2410wdt_keepalive(void)
+static int s3c2410wdt_keepalive(struct watchdog_device *wdd)
 {
...
+
+       return 0;
 }

...

-       s3c2410wdt_keepalive();
+       s3c2410wdt_keepalive(&s3c2410_wdd);”…””}”hj  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´K‰hjÐ  h²hubeh}”(h]”Œadd-the-watchdog-operations”ah ]”h"]”Œadd the watchdog operations”ah$]”h&]”uh1hµhh·h²hh³hÊh´Krubh¶)”}”(hhh]”(h»)”}”(hŒAdd the watchdog device”h]”hŒAdd the watchdog device”…””}”(hj2  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj/  h²hh³hÊh´K˜ubhÌ)”}”(hX;  Now we need to create a 'struct watchdog_device' and populate it with the
necessary information for the framework. The struct is also explained in detail
in 'watchdog-kernel-api.txt' in this directory. We pass it the mandatory
watchdog_info struct and the newly created watchdog_ops. Often, old drivers
have their own record-keeping for things like bootstatus and timeout using
static variables. Those have to be converted to use the members in
watchdog_device. Note that the timeout values are unsigned int. Some drivers
use signed int, so this has to be converted, too.”h]”hXC  Now we need to create a â€˜struct watchdog_deviceâ€™ and populate it with the
necessary information for the framework. The struct is also explained in detail
in â€˜watchdog-kernel-api.txtâ€™ in this directory. We pass it the mandatory
watchdog_info struct and the newly created watchdog_ops. Often, old drivers
have their own record-keeping for things like bootstatus and timeout using
static variables. Those have to be converted to use the members in
watchdog_device. Note that the timeout values are unsigned int. Some drivers
use signed int, so this has to be converted, too.”…””}”(hj@  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kšhj/  h²hubhÌ)”}”(hŒ0Here is a simple example for a watchdog device::”h]”hŒ/Here is a simple example for a watchdog device:”…””}”(hjN  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K£hj/  h²hubj?  )”}”(hŒv+static struct watchdog_device s3c2410_wdd = {
+       .info = &s3c2410_wdt_ident,
+       .ops = &s3c2410wdt_ops,
+};”h]”hŒv+static struct watchdog_device s3c2410_wdd = {
+       .info = &s3c2410_wdt_ident,
+       .ops = &s3c2410wdt_ops,
+};”…””}”hj\  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´K¥hj/  h²hubeh}”(h]”Œadd-the-watchdog-device”ah ]”h"]”Œadd the watchdog device”ah$]”h&]”uh1hµhh·h²hh³hÊh´K˜ubh¶)”}”(hhh]”(h»)”}”(hŒHandle the 'nowayout' feature”h]”hŒ!Handle the â€˜nowayoutâ€™ feature”…””}”(hju  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjr  h²hh³hÊh´K¬ubhÌ)”}”(hX  A few drivers use nowayout statically, i.e. there is no module parameter for it
and only CONFIG_WATCHDOG_NOWAYOUT determines if the feature is going to be
used. This needs to be converted by initializing the status variable of the
watchdog_device like this::”h]”hX  A few drivers use nowayout statically, i.e. there is no module parameter for it
and only CONFIG_WATCHDOG_NOWAYOUT determines if the feature is going to be
used. This needs to be converted by initializing the status variable of the
watchdog_device like this:”…””}”(hjƒ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´K®hjr  h²hubj?  )”}”(hŒ(.status = WATCHDOG_NOWAYOUT_INIT_STATUS,”h]”hŒ(.status = WATCHDOG_NOWAYOUT_INIT_STATUS,”…””}”hj‘  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´K³hjr  h²hubhÌ)”}”(hŒœMost drivers, however, also allow runtime configuration of nowayout, usually
by adding a module parameter. The conversion for this would be something like::”h]”hŒ›Most drivers, however, also allow runtime configuration of nowayout, usually
by adding a module parameter. The conversion for this would be something like:”…””}”(hjŸ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kµhjr  h²hubj?  )”}”(hŒ.watchdog_set_nowayout(&s3c2410_wdd, nowayout);”h]”hŒ.watchdog_set_nowayout(&s3c2410_wdd, nowayout);”…””}”hj­  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´K¸hjr  h²hubhÌ)”}”(hŒ›The module parameter itself needs to stay, everything else related to nowayout
can go, though. This will likely be some code in open(), close() or write().”h]”hŒ›The module parameter itself needs to stay, everything else related to nowayout
can go, though. This will likely be some code in open(), close() or write().”…””}”(hj»  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´Kºhjr  h²hubeh}”(h]”Œhandle-the-nowayout-feature”ah ]”h"]”Œhandle the 'nowayout' feature”ah$]”h&]”uh1hµhh·h²hh³hÊh´K¬ubh¶)”}”(hhh]”(h»)”}”(hŒRegister the watchdog device”h]”hŒRegister the watchdog device”…””}”(hjÔ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjÑ  h²hh³hÊh´K¿ubhÌ)”}”(hŒÇReplace misc_register(&miscdev) with watchdog_register_device(&watchdog_dev).
Make sure the return value gets checked and the error message, if present,
still fits. Also convert the unregister case::”h]”hŒÆReplace misc_register(&miscdev) with watchdog_register_device(&watchdog_dev).
Make sure the return value gets checked and the error message, if present,
still fits. Also convert the unregister case:”…””}”(hjâ  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÁhjÑ  h²hubj?  )”}”(hŒÍ-       ret = misc_register(&s3c2410wdt_miscdev);
+       ret = watchdog_register_device(&s3c2410_wdd);

...

-       misc_deregister(&s3c2410wdt_miscdev);
+       watchdog_unregister_device(&s3c2410_wdd);”h]”hŒÍ-       ret = misc_register(&s3c2410wdt_miscdev);
+       ret = watchdog_register_device(&s3c2410_wdd);

...

-       misc_deregister(&s3c2410wdt_miscdev);
+       watchdog_unregister_device(&s3c2410_wdd);”…””}”hjð  sbah}”(h]”h ]”h"]”h$]”h&]”jN  jO  uh1j>  h³hÊh´KÅhjÑ  h²hubeh}”(h]”Œregister-the-watchdog-device”ah ]”h"]”Œregister the watchdog device”ah$]”h&]”uh1hµhh·h²hh³hÊh´K¿ubh¶)”}”(hhh]”(h»)”}”(hŒUpdate the Kconfig-entry”h]”hŒUpdate the Kconfig-entry”…””}”(hj	  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhj  h²hh³hÊh´KÏubhÌ)”}”(hŒ;The entry for the driver now needs to select WATCHDOG_CORE:”h]”hŒ;The entry for the driver now needs to select WATCHDOG_CORE:”…””}”(hj  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÑhj  h²hubj€  )”}”(hŒ+       select WATCHDOG_CORE

”h]”j  )”}”(hhh]”j$  )”}”(hŒselect WATCHDOG_CORE

”h]”hÌ)”}”(hŒselect WATCHDOG_CORE”h]”hŒselect WATCHDOG_CORE”…””}”(hj0  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÓhj,  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j#  hj)  ubah}”(h]”h ]”h"]”h$]”h&]”j.  Œ+”uh1j  h³hÊh´KÓhj%  ubah}”(h]”h ]”h"]”h$]”h&]”uh1j  h³hÊh´KÓhj  h²hubeh}”(h]”Œupdate-the-kconfig-entry”ah ]”h"]”Œupdate the kconfig-entry”ah$]”h&]”uh1hµhh·h²hh³hÊh´KÏubh¶)”}”(hhh]”(h»)”}”(hŒ&Create a patch and send it to upstream”h]”hŒ&Create a patch and send it to upstream”…””}”(hj\  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”uh1hºhjY  h²hh³hÊh´K×ubhÌ)”}”(hŒœMake sure you understood Documentation/process/submitting-patches.rst and send your patch to
linux-watchdog@vger.kernel.org. We are looking forward to it :)”h]”(hŒ]Make sure you understood Documentation/process/submitting-patches.rst and send your patch to
”…””}”(hjj  h²hh³Nh´NubhÖ)”}”(hŒlinux-watchdog@vger.kernel.org”h]”hŒlinux-watchdog@vger.kernel.org”…””}”(hjr  h²hh³Nh´Nubah}”(h]”h ]”h"]”h$]”h&]”Œrefuri”Œ%mailto:linux-watchdog@vger.kernel.org”uh1hÕhjj  ubhŒ!. We are looking forward to it :)”…””}”(hjj  h²hh³Nh´Nubeh}”(h]”h ]”h"]”h$]”h&]”uh1hËh³hÊh´KÙhjY  h²hubeh}”(h]”Œ&create-a-patch-and-send-it-to-upstream”ah ]”h"]”Œ&create a patch and send it to upstream”ah$]”h&]”uh1hµhh·h²hh³hÊh´K×ubeh}”(h]”Œ9converting-old-watchdog-drivers-to-the-watchdog-framework”ah ]”h"]”Œ9converting old watchdog drivers to the watchdog framework”ah$]”h&]”uh1hµhhh²hh³hÊh´Kubeh}”(h]”h ]”h"]”h$]”h&]”Œsource”hÊuh1hŒcurrent_source”NŒcurrent_line”NŒsettings”Œdocutils.frontend”ŒValues”“”)”}”(hºNŒ	generator”NŒ	datestamp”NŒsource_link”NŒ
source_url”NŒtoc_backlinks”Œentry”Œfootnote_backlinks”KŒsectnum_xform”KŒstrip_comments”NŒstrip_elements_with_classes”NŒstrip_classes”NŒreport_level”KŒ
halt_level”KŒexit_status_level”KŒdebug”NŒwarning_stream”NŒ	traceback”ˆŒinput_encoding”Œ	utf-8-sig”Œinput_encoding_error_handler”Œstrict”Œoutput_encoding”Œutf-8”Œoutput_encoding_error_handler”j¿  Œerror_encoding”Œutf-8”Œerror_encoding_error_handler”Œbackslashreplace”Œlanguage_code”Œen”Œrecord_dependencies”NŒconfig”NŒ	id_prefix”hŒauto_id_prefix”Œid”Œdump_settings”NŒdump_internals”NŒdump_transforms”NŒdump_pseudo_xml”NŒexpose_internals”NŒstrict_visitor”NŒ_disable_config”NŒ_source”hÊŒ_destination”NŒ_config_files”]”Œ7/var/lib/git/docbuild/linux/Documentation/docutils.conf”aŒfile_insertion_enabled”ˆŒraw_enabled”KŒline_length_limit”M'Œpep_references”NŒpep_base_url”Œhttps://peps.python.org/”Œpep_file_url_template”Œpep-%04d”Œrfc_references”NŒrfc_base_url”Œ&https://datatracker.ietf.org/doc/html/”Œ	tab_width”KŒtrim_footnote_reference_space”‰Œsyntax_highlight”Œlong”Œsmart_quotes”ˆŒsmartquotes_locales”]”Œcharacter_level_inline_markup”‰Œdoctitle_xform”‰Œdocinfo_xform”KŒsectsubtitle_xform”‰Œimage_loading”Œlink”Œembed_stylesheet”‰Œcloak_email_addresses”ˆŒsection_self_link”‰Œenv”NubŒreporter”NŒindirect_targets”]”Œsubstitution_defs”}”Œsubstitution_names”}”Œrefnames”}”Œrefids”}”Œnameids”}”(j™  j–  jc  j`  j˜  j•  jÍ  jÊ  j,  j)  jo  jl  jÎ  jË  j  j   jV  jS  j‘  jŽ  uŒ	nametypes”}”(j™  ‰jc  ‰j˜  ‰jÍ  ‰j,  ‰jo  ‰jÎ  ‰j  ‰jV  ‰j‘  ‰uh}”(j–  h·j`  hÿj•  jf  jÊ  j›  j)  jÐ  jl  j/  jË  jr  j   jÑ  jS  j  jŽ  jY  uŒfootnote_refs”}”Œcitation_refs”}”Œautofootnotes”]”Œautofootnote_refs”]”Œsymbol_footnotes”]”Œsymbol_footnote_refs”]”Œ	footnotes”]”Œ	citations”]”Œautofootnote_start”KŒsymbol_footnote_start”K Œ
id_counter”Œcollections”ŒCounter”“”}”…”R”Œparse_messages”]”Œtransform_messages”]”Œtransformer”NŒinclude_log”]”Œ
decoration”Nh²hub.