LinCAN driver major structured comments and documentation update

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

diff --git a/lincan/src/template.c b/lincan/src/template.c
index 3075ad54af89677a9300d66aef11ca8b1151030a..6a8275708a0334f2892fee8cf61cc841b3d58088 100644 (file)
--- a/lincan/src/template.c
+++ b/lincan/src/template.c
@@ -32,9 +32,9 @@
 #define IO_RANGE 0x100
 
 /**
- * template_request_io: - reserve io memory
- * @io_addr: The reserved memory starts at @io_addr, wich is the module 
- * parameter @io.
+ * template_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
  *
  * The function template_request_io() is used to reserve the io-memory. If your
  * hardware uses a dedicated memory range as hardware control registers you
@@ -57,8 +57,8 @@ int template_request_io(struct candevice_t *candev)
 }
 
 /**
- * template_release_io - free reserved io-memory
- * @io_addr: Start of the memory range to be released.
+ * template_release_io - free reserved io memory range
+ * @candev: pointer to candevice/board which releases io
  *
  * The function template_release_io() is used to free reserved io-memory.
  * In case you have reserved more io memory, don't forget to free it here.
@@ -77,7 +77,7 @@ int template_release_io(struct candevice_t *candev)
 
 /**
  * template_reset - hardware reset routine
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function template_reset() is used to give a hardware reset. This is 
  * rather hardware specific so I haven't included example code. Don't forget to 
@@ -96,7 +96,7 @@ int template_reset(struct candevice_t *candev)
 
 /**
  * template_init_hw_data - Initialize hardware cards
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function template_init_hw_data() is used to initialize the hardware
  * structure containing information about the installed CAN-board.
@@ -122,7 +122,7 @@ int template_init_hw_data(struct candevice_t *candev)
 #define CHIP_TYPE "i82527"
 /**
  * template_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
  *
  * The function template_init_chip_data() is used to initialize the hardware
@@ -169,7 +169,7 @@ int template_init_chip_data(struct candevice_t *candev, int chipnr)
 
 /**
  * template_init_obj_data - Initialize message buffers
- * @chipnr: Number of the CAN chip
+ * @chip: Pointer to chip specific structure
  * @objnr: Number of the message buffer
  *
  * The function template_init_obj_data() is used to initialize the hardware
@@ -194,7 +194,7 @@ int template_init_obj_data(struct chip_t *chip, int objnr)
 
 /**
  * template_program_irq - program interrupts
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function template_program_irq() is used for hardware that uses 
  * programmable interrupts. If your hardware doesn't use programmable interrupts