LinCAN driver major structured comments and documentation update

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

diff --git a/lincan/src/m437.c b/lincan/src/m437.c
index c2073ed64cef8aa8376f61fcb3ca7442b8691758..b5349b8265b5b39f626454e28fb31ff052233f32 100644 (file)
--- a/lincan/src/m437.c
+++ b/lincan/src/m437.c
@@ -44,9 +44,9 @@
 static long base = 0L; 
 
 /**
- * m437_request_io: - reserve io memory
- * @io_addr: The reserved memory starts at @io_addr, wich is the module 
- * parameter @io.
+ * m437_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 m437_request_io() is used to reserve the io-memory. If your
  * hardware uses a dedicated memory range as hardware control registers you
@@ -76,8 +76,8 @@ int m437_request_io(struct candevice_t *candev)
 }
 
 /**
- * m437_release_io - free reserved io-memory
- * @io_addr: Start of the memory range to be released.
+ * m437_elease_io - free reserved io memory range
+ * @candev: pointer to candevice/board which releases io
  *
  * The function m437_release_io() is used to free reserved io-memory.
  * In case you have reserved more io memory, don't forget to free it here.
@@ -124,7 +124,7 @@ int m437_release_io(struct candevice_t *candev)
 
 /**
  * m437_reset - hardware reset routine
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function m437_reset() is used to give a hardware reset. This is 
  * rather hardware specific so I haven't included example code. Don't forget to 
@@ -142,8 +142,8 @@ int m437_reset(struct candevice_t *candev)
 #define NR_SJA1000 0
 
 /**
- * m437_init_hw_data - Initialze hardware cards
- * @card: Number of the hardware card.
+ * m437_init_hw_data - Initialize hardware cards
+ * @candev: Pointer to candevice/board structure
  *
  * The function m437_init_hw_data() is used to initialize the hardware
  * structure containing information about the installed CAN-board.
@@ -171,7 +171,7 @@ int m437_init_hw_data(struct candevice_t *candev)
 #define CHIP_TYPE "i82527"
 /**
  * m437_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 m437_init_chip_data() is used to initialize the hardware
@@ -216,7 +216,7 @@ int m437_init_chip_data(struct candevice_t *candev, int chipnr)
 
 /**
  * m437_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 m437_init_obj_data() is used to initialize the hardware
@@ -241,7 +241,7 @@ int m437_init_obj_data(struct chip_t *chip, int objnr)
 
 /**
  * m437_program_irq - program interrupts
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function m437_program_irq() is used for hardware that uses 
  * programmable interrupts. If your hardware doesn't use programmable interrupts