Commit a320274a authored by Puranjay Mohan's avatar Puranjay Mohan Committed by Jonathan Corbet
Browse files

IIO: Documentation: Replace deprecated :c:func: Usage 



Replace :c:func: with func() as the previous usage is deprecated.

Signed-off-by: default avatarPuranjay Mohan <puranjay12@gmail.com>
Link: https://lore.kernel.org/r/20200812174611.18580-1-puranjay12@gmail.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 94dea151

Documentation/driver-api/iio/core.rst

+8 −8
Original line number Original line Diff line number Diff line
@@ -11,10 +11,10 @@ Industrial I/O Devices 
----------------------

----------------------





* struct :c:type:`iio_dev` - industrial I/O device

* struct :c:type:`iio_dev` - industrial I/O device

* :c:func:`iio_device_alloc()` - allocate an :c:type:`iio_dev` from a driver

* iio_device_alloc() - allocate an :c:type:`iio_dev` from a driver

* :c:func:`iio_device_free()` - free an :c:type:`iio_dev` from a driver

* iio_device_free() - free an :c:type:`iio_dev` from a driver

* :c:func:`iio_device_register()` - register a device with the IIO subsystem

* iio_device_register() - register a device with the IIO subsystem

* :c:func:`iio_device_unregister()` - unregister a device from the IIO

* iio_device_unregister() - unregister a device from the IIO

  subsystem

  subsystem





An IIO device usually corresponds to a single hardware sensor and it

An IIO device usually corresponds to a single hardware sensor and it
@@ -34,17 +34,17 @@ A typical IIO driver will register itself as an :doc:`I2C <../i2c>` or 




At probe:

At probe:





1. Call :c:func:`iio_device_alloc()`, which allocates memory for an IIO device.

1. Call iio_device_alloc(), which allocates memory for an IIO device.

2. Initialize IIO device fields with driver specific information (e.g.

2. Initialize IIO device fields with driver specific information (e.g.

   device name, device channels).

   device name, device channels).

3. Call :c:func:`iio_device_register()`, this registers the device with the

3. Call iio_device_register(), this registers the device with the

   IIO core. After this call the device is ready to accept requests from user

   IIO core. After this call the device is ready to accept requests from user

   space applications.

   space applications.





At remove, we free the resources allocated in probe in reverse order:

At remove, we free the resources allocated in probe in reverse order:





1. :c:func:`iio_device_unregister()`, unregister the device from the IIO core.

1. iio_device_unregister(), unregister the device from the IIO core.

2. :c:func:`iio_device_free()`, free the memory allocated for the IIO device.

2. iio_device_free(), free the memory allocated for the IIO device.





IIO device sysfs interface

IIO device sysfs interface

==========================

==========================