LinCAN driver major structured comments and documentation update

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

diff --git a/lincan/src/pc_i03.c b/lincan/src/pc_i03.c
index 0490fe6fad332866e7b40848ea159272fcf38fde..daec69c4f2185f111766bea3a6fb18d59a1f6d64 100644 (file)
--- a/lincan/src/pc_i03.c
+++ b/lincan/src/pc_i03.c
@@ -32,9 +32,9 @@ unsigned int pci03_base_addr;
 #define IO_RANGE 0x200 // The pc-i03 uses an additional 0x100 bytes reset space
 
 /**
 #define IO_RANGE 0x200 // The pc-i03 uses an additional 0x100 bytes reset space
 
 /**

- * pci03_request_io: - reserve io memory
- * @io_addr: The reserved memory starts at @io_addr, wich is the module 
- * parameter @io.
+ * pci03_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 pci03_request_io() is used to reserve the io-memory. If your
  * hardware uses a dedicated memory range as hardware control registers you
  *
  * The function pci03_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 pci03_request_io(struct candevice_t *candev)
 }
 
 /**
 }
 
 /**

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

  *
  * The function pci03_release_io() is used to free reserved io-memory.
  * In case you have reserved more io memory, don't forget to free it here.
  *
  * The function pci03_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 pci03_release_io(struct candevice_t *candev)
 
 /**
  * pci03_reset - hardware reset routine
 
 /**
  * pci03_reset - hardware reset routine

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

  *
  * The function pci03_reset() is used to give a hardware reset. This is 
  * rather hardware specific so I haven't included example code. Don't forget to 
  *
  * The function pci03_reset() is used to give a hardware reset. This is 
  * rather hardware specific so I haven't included example code. Don't forget to 


@@ -119,8 +119,8 @@ int pci03_reset(struct candevice_t *candev)
 #define NR_SJA1000 1
 
 /**
 #define NR_SJA1000 1
 
 /**

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

  *
  * The function pci03_init_hw_data() is used to initialize the hardware
  * structure containing information about the installed CAN-board.
  *
  * The function pci03_init_hw_data() is used to initialize the hardware
  * structure containing information about the installed CAN-board.


@@ -144,7 +144,7 @@ int pci03_init_hw_data(struct candevice_t *candev)
 #define CHIP_TYPE "sja1000"
 /**
  * pci03_init_chip_data - Initialize chips
 #define CHIP_TYPE "sja1000"
 /**
  * pci03_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 pci03_init_chip_data() is used to initialize the hardware
  * @chipnr: Number of the CAN chip on the hardware card
  *
  * The function pci03_init_chip_data() is used to initialize the hardware


@@ -186,7 +186,7 @@ int pci03_init_chip_data(struct candevice_t *candev, int chipnr)
 
 /**
  * pci03_init_obj_data - Initialize message buffers
 
 /**
  * pci03_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 pci03_init_obj_data() is used to initialize the hardware
  * @objnr: Number of the message buffer
  *
  * The function pci03_init_obj_data() is used to initialize the hardware


@@ -211,7 +211,7 @@ int pci03_init_obj_data(struct chip_t *chip, int objnr)
 
 /**
  * pci03_program_irq - program interrupts
 
 /**
  * pci03_program_irq - program interrupts

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

  *
  * The function pci03_program_irq() is used for hardware that uses 
  * programmable interrupts. If your hardware doesn't use programmable interrupts
  *
  * The function pci03_program_irq() is used for hardware that uses 
  * programmable interrupts. If your hardware doesn't use programmable interrupts