[v2,1/5] regmap: Add missing comments about struct regmap_bus

Commit Message

Markus Pargmann Aug. 20, 2015, 9:12 a.m. UTC

There are some fields of this struct undocumented or old. This patch
updates the missing comments.

Signed-off-by: Markus Pargmann <[e-mail]>
---
 include/linux/regmap.h | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Mark Brown Aug. 20, 2015, 6:20 p.m. UTC | #1

On Thu, Aug 20, 2015 at 11:12:32AM +0200, Markus Pargmann wrote:

>   * @async_write: Write operation which completes asynchronously, optional and
>   *               must serialise with respect to non-async I/O.
> + * @reg_write: Write operation for a register. Writes value to register.

This seems like documenation for the sake of filling in the blank :(  At
least distinguish it from async_write() please.

Patch

diff --git a/include/linux/regmap.h b/include/linux/regmap.h
index 59c55ea0f0b5..915454a1b54e 100644
--- a/include/linux/regmap.h
+++ b/include/linux/regmap.h
@@ -296,8 +296,11 @@  typedef void (*regmap_hw_free_context)(void *context);
  *                if not implemented  on a given device.
  * @async_write: Write operation which completes asynchronously, optional and
  *               must serialise with respect to non-async I/O.
+ * @reg_write: Write operation for a register. Writes value to register.
  * @read: Read operation.  Data is returned in the buffer used to transmit
  *         data.
+ * @reg_read: Read operation for a register. Reads a value from a register.
+ * @free_context: Free context.
  * @async_alloc: Allocate a regmap_async() structure.
  * @read_flag_mask: Mask to be set in the top byte of the register when doing
  *                  a read.
@@ -307,7 +310,6 @@  typedef void (*regmap_hw_free_context)(void *context);
  * @val_format_endian_default: Default endianness for formatted register
  *     values. Used when the regmap_config specifies DEFAULT. If this is
  *     DEFAULT, BIG is assumed.
- * @async_size: Size of struct used for async work.
  */
 struct regmap_bus {
 	bool fast_io;