LinCAN driver major structured comments and documentation update

[lincan.git] / lincan / src / virtual.c

diff --git a/lincan/src/virtual.c b/lincan/src/virtual.c
index 5b39ecf4257dbbf3af203543d4bc148a203233b5..42c0f57c6c0ab551c7a60f9d57f64d9ba24ac822 100644 (file)
--- a/lincan/src/virtual.c
+++ b/lincan/src/virtual.c
@@ -307,9 +307,9 @@ int virtual_wakeup_tx(struct chip_t *chip, struct msgobj_t *obj)
 /* * * Virtual Board Functionality * * */
 
 /**
 /* * * Virtual Board Functionality * * */
 
 /**

- * virtual_request_io: - reserve io memory
- * @io_addr: The reserved memory starts at @io_addr, wich is the module 
- * parameter @io.
+ * virtual_request_io: - reserve io or memory range for can board
+ * @candev: pointer to candevice/board which asks for io. Field @io_addr
+ *     of @candev is used in most cases to define start of the range

  *
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/virtual.c
  *
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/virtual.c


@@ -320,8 +320,8 @@ int virtual_request_io(struct candevice_t *candev)
 }
 
 /**
 }
 
 /**

- * virtual_release_io - free reserved io-memory
- * @io_addr: Start of the memory range to be released.
+ * virtual_elease_io - free reserved io memory range
+ * @candev: pointer to candevice/board which releases io

  *
  * Return Value: The function always returns zero
  * File: src/virtual.c
  *
  * Return Value: The function always returns zero
  * File: src/virtual.c


@@ -333,7 +333,7 @@ int virtual_release_io(struct candevice_t *candev)
 
 /**
  * virtual_reset - hardware reset routine
 
 /**
  * virtual_reset - hardware reset routine

- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure

  *
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/virtual.c
  *
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/virtual.c


@@ -344,8 +344,8 @@ int virtual_reset(struct candevice_t *candev)
 }
 
 /**
 }
 
 /**

- * virtual_init_hw_data - Initialze hardware cards
- * @card: Number of the hardware card.
+ * virtual_init_hw_data - Initialize hardware cards
+ * @candev: Pointer to candevice/board structure

  *
  * Return Value: The function always returns zero
  * File: src/virtual.c
  *
  * Return Value: The function always returns zero
  * File: src/virtual.c


@@ -365,7 +365,7 @@ int virtual_init_hw_data(struct candevice_t *candev)
 
 /**
  * virtual_init_chip_data - Initialize chips
 
 /**
  * virtual_init_chip_data - Initialize chips

- * @card: Number of the hardware card
+ * @candev: Pointer to candevice/board structure

  * @chipnr: Number of the CAN chip on the hardware card
  *
  * Return Value: The function always returns zero
  * @chipnr: Number of the CAN chip on the hardware card
  *
  * Return Value: The function always returns zero


@@ -407,7 +407,7 @@ int virtual_init_chip_data(struct candevice_t *candev, int chipnr)
 
 /**
  * virtual_init_obj_data - Initialize message buffers
 
 /**
  * virtual_init_obj_data - Initialize message buffers

- * @chipnr: Number of the CAN chip
+ * @chip: Pointer to chip specific structure

  * @objnr: Number of the message buffer
  *
  * Return Value: The function always returns zero
  * @objnr: Number of the message buffer
  *
  * Return Value: The function always returns zero


@@ -422,7 +422,7 @@ int virtual_init_obj_data(struct chip_t *chip, int objnr)
 
 /**
  * virtual_program_irq - program interrupts
 
 /**
  * virtual_program_irq - program interrupts

- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure

  *
  * Return value: The function returns zero on success or %-ENODEV on failure
  * File: src/virtual.c
  *
  * Return value: The function returns zero on success or %-ENODEV on failure
  * File: src/virtual.c