Structured comments updated.

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

diff --git a/lincan/src/pikronisa.c b/lincan/src/pikronisa.c
index 703adade9be0658527e76c2bd308d668ff64ea60..57788758b4f64a13d2879b165392c8a7a4056666 100644 (file)
--- a/lincan/src/pikronisa.c
+++ b/lincan/src/pikronisa.c
@@ -7,13 +7,8 @@
  * Version lincan-0.2  9 Jul 2003
  */ 
 
  * 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/pikronisa.h"
 #include "../include/i82527.h"
 #include "../include/main.h"
 #include "../include/pikronisa.h"
 #include "../include/i82527.h"


@@ -27,9 +22,9 @@
 #define IO_RANGE 0x100
 
 /**
 #define IO_RANGE 0x100
 
 /**

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


@@ -60,8 +55,8 @@ int pikronisa_request_io(struct candevice_t *candev)
 }
 
 /**
 }
 
 /**

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

  *
  * The function pikronisa_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 pikronisa_release_io() is used to free reserved io-memory.
  * In case you have reserved more io memory, don't forget to free it here.


@@ -82,7 +77,7 @@ int pikronisa_release_io(struct candevice_t *candev)
 
 /**
  * pikronisa_reset - hardware reset routine
 
 /**
  * pikronisa_reset - hardware reset routine

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

  *
  * The function pikronisa_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 pikronisa_reset() is used to give a hardware reset. This is 
  * rather hardware specific so I haven't included example code. Don't forget to 


@@ -125,15 +120,15 @@ int pikronisa_reset(struct candevice_t *candev)
 #define NR_SJA1000 1
 
 /**
 #define NR_SJA1000 1
 
 /**

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

  *
  * The function pikronisa_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 function pikronisa_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/pikronisa.c
  * the hardware uses programmable interrupts.
  * Return Value: The function always returns zero
  * File: src/pikronisa.c


@@ -144,7 +139,7 @@ int pikronisa_init_hw_data(struct candevice_t *candev)
        candev->nr_82527_chips=0;
        candev->nr_sja1000_chips=1;
        candev->nr_all_chips=1;
        candev->nr_82527_chips=0;
        candev->nr_sja1000_chips=1;
        candev->nr_all_chips=1;

-       candev->flags |= PROGRAMMABLE_IRQ*0;
+       candev->flags |= CANDEV_PROGRAMMABLE_IRQ*0;

 
        return 0;
 }
 
        return 0;
 }


@@ -154,7 +149,7 @@ int pikronisa_init_hw_data(struct candevice_t *candev)
 
 /**
  * pikronisa_init_chip_data - Initialize chips
 
 /**
  * pikronisa_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 pikronisa_init_chip_data() is used to initialize the hardware
  * @chipnr: Number of the CAN chip on the hardware card
  *
  * The function pikronisa_init_chip_data() is used to initialize the hardware


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


@@ -217,17 +212,16 @@ int pikronisa_init_chip_data(struct candevice_t *candev, int chipnr)
 int pikronisa_init_obj_data(struct chip_t *chip, int objnr)
 {
        chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
 int pikronisa_init_obj_data(struct chip_t *chip, int objnr)
 {
        chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;

-       chip->msgobj[objnr]->flags=0;

        return 0;
 }
 
 /**
  * pikronisa_program_irq - program interrupts
        return 0;
 }
 
 /**
  * pikronisa_program_irq - program interrupts

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

  *
  * The function pikronisa_program_irq() is used for hardware that uses 
  * programmable interrupts. If your hardware doesn't use programmable interrupts
  *
  * The function pikronisa_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
  * 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