]> rtime.felk.cvut.cz Git - lincan.git/blobdiff - lincan/src/pcccan.c
LinCAN driver major structured comments and documentation update
[lincan.git] / lincan / src / pcccan.c
index e7b5b22fa584ceaa6556f2d5b40fdf1c43037126..0ca6f284ef16f069ee7fc851359ee1faa2050591 100644 (file)
@@ -1,8 +1,10 @@
 /* pcccan.c
  * Linux CAN-bus device driver.
  * Written by Arnaud Westenberg email:arnaud@wanadoo.nl
+ * Rewritten for new CAN queues by Pavel Pisa - OCERA team member
+ * email:pisa@cmp.felk.cvut.cz
  * This software is released under the GPL-License.
- * Version 0.7  6 Aug 2001
+ * Version lincan-0.2  9 Jul 2003
  */ 
 
 /* This file contains the low level functions for the pcccan-1 card from Gespac.
  */
 
 #include <linux/autoconf.h>
-#if defined (CONFIG_MODVERSIONS) && !defined (MODVERSIONS)
-#define MODVERSIONS
-#endif
-
-#if defined (MODVERSIONS)
-#include <linux/modversions.h>
-#endif
 
 #include <linux/ioport.h>
 #include <linux/delay.h>
@@ -53,9 +48,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
@@ -66,22 +61,20 @@ unsigned long pcccan_base=0x0;
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/pcccan.c
  */
-int pcccan_request_io(unsigned long io_addr)
+int pcccan_request_io(struct candevice_t *candev)
 {
-       if (check_region(io_addr,IO_RANGE)) {
-               CANMSG("Unable to open port: 0x%lx\n",io_addr);
+       if (!can_request_io_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
+               CANMSG("Unable to open port: 0x%lx\n",candev->io_addr);
                return -ENODEV;
-       }
-       else {
-               request_region(io_addr,IO_RANGE,DEVICE_NAME);
-               DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", io_addr, io_addr + IO_RANGE - 1);
+       } else {
+               DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
        }
        return 0;
 }
 
 /**
- * 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.
@@ -91,16 +84,16 @@ int pcccan_request_io(unsigned long io_addr)
  * Return Value: The function always returns zero
  * File: src/pcccan.c
  */
-int pcccan_release_io(unsigned long io_addr)
+int pcccan_release_io(struct candevice_t *candev)
 {
-       release_region(io_addr,IO_RANGE);
+       can_release_io_region(candev->io_addr,IO_RANGE);
 
        return 0;
 }
 
 /**
  * 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 
@@ -108,20 +101,20 @@ int pcccan_release_io(unsigned long io_addr)
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/pcccan.c
  */
-int pcccan_reset(int card)
+int pcccan_reset(struct candevice_t *candev)
 {
        int i=0;
 
        DEBUGMSG("Resetting pcccan-1 hardware ...\n");
        while (i < 1000000) {
                i++;
-               outb(0x0,candevices_p[card]->res_addr);
+               outb(0x0,candev->res_addr);
        }
 
        /* Check hardware reset status */
        i=0;
-       outb(iCPU,candevices_p[card]->io_addr+0x1);
-       while ( (inb(candevices_p[card]->io_addr+0x2)&0x80) && (i<=15) ) {
+       outb(iCPU,candev->io_addr+0x1);
+       while ( (inb(candev->io_addr+0x2)&0x80) && (i<=15) ) {
                udelay(20000);
                i++;
        }
@@ -140,8 +133,8 @@ int pcccan_reset(int card)
 #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.
@@ -153,12 +146,13 @@ int pcccan_reset(int card)
  * Return Value: The function always returns zero
  * File: src/pcccan.c
  */
-int pcccan_init_hw_data(int card
+int pcccan_init_hw_data(struct candevice_t *candev
 {
-       candevices_p[card]->res_addr=candevices_p[card]->io_addr;
-       candevices_p[card]->nr_82527_chips=NR_82527;
-       candevices_p[card]->nr_sja1000_chips=NR_SJA1000;
-       candevices_p[card]->flags |= ~PROGRAMMABLE_IRQ;
+       candev->res_addr=candev->io_addr;
+       candev->nr_82527_chips=NR_82527;
+       candev->nr_sja1000_chips=NR_SJA1000;
+        candev->nr_all_chips=NR_82527+NR_SJA1000;
+       candev->flags &= ~PROGRAMMABLE_IRQ;
 
        return 0;
 }
@@ -166,7 +160,7 @@ int pcccan_init_hw_data(int card)
 #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
@@ -196,25 +190,25 @@ int pcccan_init_hw_data(int card)
  * Return Value: The function always returns zero
  * File: src/pcccan.c
  */
-int pcccan_init_chip_data(int card, int chipnr)
+int pcccan_init_chip_data(struct candevice_t *candev, int chipnr)
 {
-       candevices_p[card]->chip[chipnr]->chip_type=CHIP_TYPE;
-       candevices_p[card]->chip[chipnr]->chip_base_addr=candevices_p[card]->io_addr;
-       candevices_p[card]->chip[chipnr]->clock = 16000000;
-       candevices_p[card]->chip[chipnr]->int_cpu_reg = iCPU_DSC | iCPU_DMC;
-       candevices_p[card]->chip[chipnr]->int_clk_reg = iCLK_SL1 | iCLK_CD0;
-       candevices_p[card]->chip[chipnr]->int_bus_reg = iBUS_CBY | iBUS_DR1;
-       candevices_p[card]->chip[chipnr]->sja_cdr_reg = 0;
-       candevices_p[card]->chip[chipnr]->sja_ocr_reg = 0;
-       pcccan_irq=candevices_p[card]->chip[chipnr]->chip_irq;
-       pcccan_base=candevices_p[card]->chip[chipnr]->chip_base_addr;
+       candev->chip[chipnr]->chip_type=CHIP_TYPE;
+       candev->chip[chipnr]->chip_base_addr=candev->io_addr;
+       candev->chip[chipnr]->clock = 16000000;
+       candev->chip[chipnr]->int_cpu_reg = iCPU_DSC | iCPU_DMC;
+       candev->chip[chipnr]->int_clk_reg = iCLK_SL1 | iCLK_CD0;
+       candev->chip[chipnr]->int_bus_reg = iBUS_CBY | iBUS_DR1;
+       candev->chip[chipnr]->sja_cdr_reg = 0;
+       candev->chip[chipnr]->sja_ocr_reg = 0;
+       pcccan_irq=candev->chip[chipnr]->chip_irq;
+       pcccan_base=candev->chip[chipnr]->chip_base_addr;
 
        return 0;
 }
 
 /**
  * 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
@@ -229,17 +223,17 @@ int pcccan_init_chip_data(int card, int chipnr)
  * Return Value: The function always returns zero
  * File: src/pcccan.c
  */
-int pcccan_init_obj_data(int chipnr, int objnr)
+int pcccan_init_obj_data(struct chip_t *chip, int objnr)
 {
-       chips_p[chipnr]->msgobj[objnr]->obj_base_addr=(objnr+1)*0x10;
-       chips_p[chipnr]->msgobj[objnr]->flags=0;
+       chip->msgobj[objnr]->obj_base_addr=(objnr+1)*0x10;
+       chip->msgobj[objnr]->flags=0;
        
        return 0;
 }
 
 /**
  * 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
@@ -249,7 +243,7 @@ int pcccan_init_obj_data(int chipnr, int objnr)
  * Return value: The function returns zero on success or %-ENODEV on failure
  * File: src/pcccan.c
  */
-int pcccan_program_irq(int card)
+int pcccan_program_irq(struct candevice_t *candev)
 {
        return 0;
 }