]> rtime.felk.cvut.cz Git - lincan.git/blobdiff - lincan/src/template.c
Structured comments updated.
[lincan.git] / lincan / src / template.c
index 1c638ae59c03dab5a5d622eaf0edb06e8747bed8..f53022855fe1897ce08e7e7015fdc7b7cba2f45f 100644 (file)
@@ -1,8 +1,10 @@
 /* template.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 is intended as a template file for currently unsupported hardware.
  * possible to load the driver with the hardware option hw=template.
  */
 
-#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>
-#include <asm/errno.h>
-#include <asm/io.h>
-
+#include "../include/can.h"
+#include "../include/can_sysdep.h"
 #include "../include/main.h"
 #include "../include/template.h"
 #include "../include/i82527.h"
@@ -37,9 +27,9 @@
 #define IO_RANGE 0x100
 
 /**
- * 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
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/template.c
  */
-int template_request_io(unsigned long io_addr)
+int template_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;
 }
 
 /**
- * template_release_io - free reserved io-memory
- * @io_addr: Start of the memory range to be released.
+ * template_release_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.
@@ -75,16 +63,16 @@ int template_request_io(unsigned long io_addr)
  * Return Value: The function always returns zero
  * File: src/template.c
  */
-int template_release_io(unsigned long io_addr)
+int template_release_io(struct candevice_t *candev)
 {
-       release_region(io_addr,IO_RANGE);
+       can_release_io_region(candev->io_addr,IO_RANGE);
 
        return 0;
 }
 
 /**
  * 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 
@@ -92,35 +80,36 @@ int template_release_io(unsigned long io_addr)
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/template.c
  */
-int template_reset(int card)
+int template_reset(struct candevice_t *candev)
 {
        return 0;
 }
 
 #define RESET_ADDR 0x0
-#define NR_82527 0
+#define NR_82527 1
 #define NR_SJA1000 0
 
 /**
- * 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
+ * %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 %CANDEV_PROGRAMMABLE_IRQ to indicate that
  * the hardware uses programmable interrupts.
  * Return Value: The function always returns zero
  * File: src/template.c
  */
-int template_init_hw_data(int card
+int template_init_hw_data(struct candevice_t *candev
 {
-       candevices_p[card]->res_addr=RESET_ADDR;
-       candevices_p[card]->nr_82527_chips=1;
-       candevices_p[card]->nr_sja1000_chips=0;
-       candevices_p[card]->flags |= PROGRAMMABLE_IRQ;
+       candev->res_addr=RESET_ADDR;
+       candev->nr_82527_chips=NR_82527;
+       candev->nr_sja1000_chips=NR_SJA1000;
+       candev->nr_all_chips=NR_82527+NR_SJA1000;
+       candev->flags |= CANDEV_PROGRAMMABLE_IRQ;
 
        return 0;
 }
@@ -128,7 +117,7 @@ int template_init_hw_data(int card)
 #define CHIP_TYPE "i82527"
 /**
  * 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
@@ -158,16 +147,16 @@ int template_init_hw_data(int card)
  * Return Value: The function always returns zero
  * File: src/template.c
  */
-int template_init_chip_data(int card, int chipnr)
+int template_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;
-       candevices_p[card]->chip[chipnr]->int_clk_reg = iCLK_SL1;
-       candevices_p[card]->chip[chipnr]->int_bus_reg = iBUS_CBY;
-       candevices_p[card]->chip[chipnr]->sja_cdr_reg = CDR_CBP | CDR_CLK_OFF;
-       candevices_p[card]->chip[chipnr]->sja_ocr_reg = OCR_MODE_NORMAL |
+       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;
+       candev->chip[chipnr]->int_clk_reg = iCLK_SL1;
+       candev->chip[chipnr]->int_bus_reg = iBUS_CBY;
+       candev->chip[chipnr]->sja_cdr_reg = CDR_CBP | CDR_CLK_OFF;
+       candev->chip[chipnr]->sja_ocr_reg = OCR_MODE_NORMAL |
                                                                OCR_TX0_LH;
 
        return 0;
@@ -175,7 +164,7 @@ int template_init_chip_data(int card, 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
@@ -190,27 +179,26 @@ int template_init_chip_data(int card, int chipnr)
  * Return Value: The function always returns zero
  * File: src/template.c
  */
-int template_init_obj_data(int chipnr, int objnr)
+int template_init_obj_data(struct chip_t *chip, int objnr)
 {
-       chips_p[chipnr]->msgobj[objnr]->obj_base_addr=chips_p[chipnr]->chip_base_addr+(objnr+1)*0x10;
-       chips_p[chipnr]->msgobj[objnr]->flags=0;
+       chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr+(objnr+1)*0x10;
        
        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
  * File: src/template.c
  */
-int template_program_irq(int card)
+int template_program_irq(struct candevice_t *candev)
 {
        return 0;
 }