Header-files cleanup and CAN queue edges and ends locking reimplemented.

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

diff --git a/lincan/src/pcccan.c b/lincan/src/pcccan.c
index 290a44a34471b3b5e5a0fd31126d3e4e026cb888..6f7b5766fbd47ad0963973c17c119110f3034ebc 100644 (file)
--- a/lincan/src/pcccan.c
+++ b/lincan/src/pcccan.c
@@ -11,15 +11,8 @@
  * You can probably find more information at http://www.gespac.com
  */
 
-#include <linux/autoconf.h>
-
-#include <linux/ioport.h>
-#include <linux/delay.h>
-#include <linux/sched.h>
-#include <asm/errno.h>
-#include <asm/io.h>
-#include <asm/irq.h>
-
+#include "../include/can.h"
+#include "../include/can_sysdep.h"
 #include "../include/main.h"
 #include "../include/pcccan.h"
 #include "../include/i82527.h"
@@ -48,9 +41,9 @@ unsigned long pcccan_base=0x0;
 #define IO_RANGE 0x8
 
 /**
- * pcccan_request_io: - reserve io memory
- * @io_addr: The reserved memory starts at @io_addr, wich is the module 
- * parameter @io.
+ * pcccan_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 pcccan_request_io() is used to reserve the io-memory. If your
  * hardware uses a dedicated memory range as hardware control registers you
@@ -73,8 +66,8 @@ int pcccan_request_io(struct candevice_t *candev)
 }
 
 /**
- * pcccan_release_io - free reserved io-memory
- * @io_addr: Start of the memory range to be released.
+ * pcccan_elease_io - free reserved io memory range
+ * @candev: pointer to candevice/board which releases io
  *
  * The function pcccan_release_io() is used to free reserved io-memory.
  * In case you have reserved more io memory, don't forget to free it here.
@@ -93,7 +86,7 @@ int pcccan_release_io(struct candevice_t *candev)
 
 /**
  * pcccan_reset - hardware reset routine
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function pcccan_reset() is used to give a hardware reset. This is 
  * rather hardware specific so I haven't included example code. Don't forget to 
@@ -133,15 +126,15 @@ int pcccan_reset(struct candevice_t *candev)
 #define NR_SJA1000 0
 
 /**
- * pcccan_init_hw_data - Initialze hardware cards
- * @card: Number of the hardware card.
+ * pcccan_init_hw_data - Initialize hardware cards
+ * @candev: Pointer to candevice/board structure
  *
  * The function pcccan_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/pcccan.c
@@ -152,7 +145,7 @@ int pcccan_init_hw_data(struct candevice_t *candev)
        candev->nr_82527_chips=NR_82527;
        candev->nr_sja1000_chips=NR_SJA1000;
         candev->nr_all_chips=NR_82527+NR_SJA1000;
-       candev->flags &= ~PROGRAMMABLE_IRQ;
+       candev->flags &= ~CANDEV_PROGRAMMABLE_IRQ;
 
        return 0;
 }
@@ -160,7 +153,7 @@ int pcccan_init_hw_data(struct candevice_t *candev)
 #define CHIP_TYPE "i82527"
 /**
  * pcccan_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 pcccan_init_chip_data() is used to initialize the hardware
@@ -208,7 +201,7 @@ int pcccan_init_chip_data(struct candevice_t *candev, int chipnr)
 
 /**
  * pcccan_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 pcccan_init_obj_data() is used to initialize the hardware
@@ -233,11 +226,11 @@ int pcccan_init_obj_data(struct chip_t *chip, int objnr)
 
 /**
  * pcccan_program_irq - program interrupts
- * @card: Number of the hardware card.
+ * @candev: Pointer to candevice/board structure
  *
  * The function pcccan_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