Structured comments updated.

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

diff --git a/lincan/src/aim104.c b/lincan/src/aim104.c
index da8afc087a34e8447ce765fb30249de05e119c20..cc2480612839223737003a7cc1cd73142c2acb23 100644 (file)
--- a/lincan/src/aim104.c
+++ b/lincan/src/aim104.c
@@ -7,13 +7,8 @@
  * Version lincan-0.2  9 Jul 2003
  */ 
 
-#include <linux/autoconf.h>
-
-#include <linux/ioport.h>
-#include <linux/delay.h>
-#include <asm/errno.h>
-#include <asm/io.h>
-
+#include "../include/can.h"
+#include "../include/can_sysdep.h"
 #include "../include/main.h"
 #include "../include/aim104.h"
 #include "../include/sja1000.h"
@@ -26,9 +21,9 @@
 #define IO_RANGE 0x20
 
 /**
- * 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
@@ -51,8 +46,8 @@ int aim104_request_io(struct candevice_t *candev)
 }
 
 /**
- * template_release_io - free reserved io-memory
- * @io_addr: Start of the memory range to be released.
+ * template_elease_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.
@@ -71,7 +66,7 @@ int aim104_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 
@@ -110,15 +105,15 @@ int aim104_reset(struct candevice_t *candev)
 #define NR_SJA1000 1
 
 /**
- * template_init_hw_data - Initialze hardware cards
- * @card: Number of the hardware card.
+ * template_init_hw_data - Initialize hardware cards
+ * @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.
  * %RESET_ADDR represents the io-address of the hardware reset register.
  * %NR_82527 represents the number of intel 82527 chips on the board.
  * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
- * The flags entry can currently only be %PROGRAMMABLE_IRQ to indicate that
+ * The flags entry can currently only be %CANDEV_PROGRAMMABLE_IRQ to indicate that
  * the hardware uses programmable interrupts.
  * Return Value: The function always returns zero
  * File: src/template.c
@@ -129,7 +124,7 @@ int aim104_init_hw_data(struct candevice_t *candev)
        candev->nr_82527_chips=0;
         candev->nr_sja1000_chips=1;
        candev->nr_all_chips=1;
-       candev->flags &= ~PROGRAMMABLE_IRQ;
+       candev->flags &= ~CANDEV_PROGRAMMABLE_IRQ;
 
        return 0;
 }
@@ -137,7 +132,7 @@ int aim104_init_hw_data(struct candevice_t *candev)
 #define CHIP_TYPE "sja1000"
 /**
  * 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
@@ -178,7 +173,7 @@ int aim104_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
@@ -196,18 +191,18 @@ int aim104_init_chip_data(struct candevice_t *candev, int chipnr)
 int aim104_init_obj_data(struct chip_t *chip, int objnr)
 {
        chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
-       chip->msgobj[objnr]->flags=0;
+       chip->msgobj[objnr]->obj_flags=0;
        
        return 0;
 }
 
 /**
  * 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
- * you should not set the @candevices_t->flags entry to %PROGRAMMABLE_IRQ and 
+ * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and 
  * leave this function unedited. Again this function is hardware specific so 
  * there's no example code.
  * Return value: The function returns zero on success or %-ENODEV on failure