lincan/src/aim104.c

   1 /* aim104.c
   2  * Linux CAN-bus device driver.
   3  * Written by Arnaud Westenberg email:arnaud@wanadoo.nl
   4  * Rewritten for new CAN queues by Pavel Pisa - OCERA team member
   5  * email:pisa@cmp.felk.cvut.cz
   6  * This software is released under the GPL-License.
   7  * Version lincan-0.2  9 Jul 2003
   8  */
   9
  10 #include <linux/autoconf.h>
  11
  12 #include <linux/ioport.h>
  13 #include <linux/delay.h>
  14 #include <asm/errno.h>
  15 #include <asm/io.h>
  16
  17 #include "../include/main.h"
  18 #include "../include/aim104.h"
  19 #include "../include/sja1000.h"
  20
  21 /*
  22  * IO_RANGE is the io-memory range that gets reserved, please adjust according
  23  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  24  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  25  */
  26 #define IO_RANGE 0x20
  27
  28 /**
  29  * template_request_io: - reserve io or memory range for can board
  30  * @candev: pointer to candevice/board which asks for io. Field @io_addr
  31  *      of @candev is used in most cases to define start of the range
  32  *
  33  * The function template_request_io() is used to reserve the io-memory. If your
  34  * hardware uses a dedicated memory range as hardware control registers you
  35  * will have to add the code to reserve this memory as well.
  36  * %IO_RANGE is the io-memory range that gets reserved, please adjust according
  37  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  38  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  39  * Return Value: The function returns zero on success or %-ENODEV on failure
  40  * File: src/template.c
  41  */
  42 int aim104_request_io(struct candevice_t *candev)
  43 {
  44         if (!can_request_io_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
  45                 CANMSG("Unable to open port: 0x%lx\n",candev->io_addr);
  46                 return -ENODEV;
  47         } else {
  48                 DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
  49         }
  50         return 0;
  51 }
  52
  53 /**
  54  * template_elease_io - free reserved io memory range
  55  * @candev: pointer to candevice/board which releases io
  56  *
  57  * The function template_release_io() is used to free reserved io-memory.
  58  * In case you have reserved more io memory, don't forget to free it here.
  59  * IO_RANGE is the io-memory range that gets released, please adjust according
  60  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  61  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  62  * Return Value: The function always returns zero
  63  * File: src/template.c
  64  */
  65 int aim104_release_io(struct candevice_t *candev)
  66 {
  67         can_release_io_region(candev->io_addr,IO_RANGE);
  68
  69         return 0;
  70 }
  71
  72 /**
  73  * template_reset - hardware reset routine
  74  * @candev: Pointer to candevice/board structure
  75  *
  76  * The function template_reset() is used to give a hardware reset. This is
  77  * rather hardware specific so I haven't included example code. Don't forget to
  78  * check the reset status of the chip before returning.
  79  * Return Value: The function returns zero on success or %-ENODEV on failure
  80  * File: src/template.c
  81  */
  82 int aim104_reset(struct candevice_t *candev)
  83 {
  84         int i=0;
  85
  86         DEBUGMSG("Resetting aim104 hardware ...\n");
  87
  88         aim104_write_register(0x00, candev->io_addr + SJACR);
  89
  90         /* Check hardware reset status chip 0 */
  91         i=0;
  92         while ( (aim104_read_register(candev->io_addr + SJACR)
  93                                                         & CR_RR) && (i<=15) ) {
  94                 udelay(20000);
  95                 i++;
  96         }
  97         if (i>=15) {
  98                 CANMSG("Reset status timeout!\n");
  99                 CANMSG("Please check your hardware.\n");
 100                 return -ENODEV;
 101         }
 102         else
 103                 DEBUGMSG("Chip reset status ok.\n");
 104
 105         return 0;
 106 }
 107
 108 #define RESET_ADDR 0x0
 109 #define NR_82527 0
 110 #define NR_SJA1000 1
 111
 112 /**
 113  * template_init_hw_data - Initialize hardware cards
 114  * @candev: Pointer to candevice/board structure
 115  *
 116  * The function template_init_hw_data() is used to initialize the hardware
 117  * structure containing information about the installed CAN-board.
 118  * %RESET_ADDR represents the io-address of the hardware reset register.
 119  * %NR_82527 represents the number of intel 82527 chips on the board.
 120  * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
 121  * The flags entry can currently only be %PROGRAMMABLE_IRQ to indicate that
 122  * the hardware uses programmable interrupts.
 123  * Return Value: The function always returns zero
 124  * File: src/template.c
 125  */
 126 int aim104_init_hw_data(struct candevice_t *candev)
 127 {
 128         candev->res_addr=RESET_ADDR;
 129         candev->nr_82527_chips=0;
 130         candev->nr_sja1000_chips=1;
 131         candev->nr_all_chips=1;
 132         candev->flags &= ~PROGRAMMABLE_IRQ;
 133
 134         return 0;
 135 }
 136
 137 #define CHIP_TYPE "sja1000"
 138 /**
 139  * template_init_chip_data - Initialize chips
 140  * @candev: Pointer to candevice/board structure
 141  * @chipnr: Number of the CAN chip on the hardware card
 142  *
 143  * The function template_init_chip_data() is used to initialize the hardware
 144  * structure containing information about the CAN chips.
 145  * %CHIP_TYPE represents the type of CAN chip. %CHIP_TYPE can be "i82527" or
 146  * "sja1000".
 147  * The @chip_base_addr entry represents the start of the 'official' memory map
 148  * of the installed chip. It's likely that this is the same as the @io_addr
 149  * argument supplied at module loading time.
 150  * The @clock entry holds the chip clock value in Hz.
 151  * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider
 152  * register. Options defined in the %sja1000.h file:
 153  * %CDR_CLKOUT_MASK, %CDR_CLK_OFF, %CDR_RXINPEN, %CDR_CBP, %CDR_PELICAN
 154  * The entry @sja_ocr_reg holds hardware specific options for the Output Control
 155  * register. Options defined in the %sja1000.h file:
 156  * %OCR_MODE_BIPHASE, %OCR_MODE_TEST, %OCR_MODE_NORMAL, %OCR_MODE_CLOCK,
 157  * %OCR_TX0_LH, %OCR_TX1_ZZ.
 158  * The entry @int_clk_reg holds hardware specific options for the Clock Out
 159  * register. Options defined in the %i82527.h file:
 160  * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
 161  * The entry @int_bus_reg holds hardware specific options for the Bus
 162  * Configuration register. Options defined in the %i82527.h file:
 163  * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
 164  * Return Value: The function always returns zero
 165  * File: src/template.c
 166  */
 167 int aim104_init_chip_data(struct candevice_t *candev, int chipnr)
 168 {
 169         candev->chip[chipnr]->chip_type=CHIP_TYPE;
 170         candev->chip[chipnr]->chip_base_addr=candev->io_addr;
 171         candev->chip[chipnr]->clock = 16000000;
 172         candev->chip[chipnr]->flags = 0;
 173         candev->chip[chipnr]->sja_cdr_reg = 0x08;
 174         candev->chip[chipnr]->sja_ocr_reg = 0xfa;
 175
 176         return 0;
 177 }
 178
 179 /**
 180  * template_init_obj_data - Initialize message buffers
 181  * @chip: Pointer to chip specific structure
 182  * @objnr: Number of the message buffer
 183  *
 184  * The function template_init_obj_data() is used to initialize the hardware
 185  * structure containing information about the different message objects on the
 186  * CAN chip. In case of the sja1000 there's only one message object but on the
 187  * i82527 chip there are 15.
 188  * The code below is for a i82527 chip and initializes the object base addresses
 189  * The entry @obj_base_addr represents the first memory address of the message
 190  * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
 191  * base address.
 192  * Unless the hardware uses a segmented memory map, flags can be set zero.
 193  * Return Value: The function always returns zero
 194  * File: src/template.c
 195  */
 196 int aim104_init_obj_data(struct chip_t *chip, int objnr)
 197 {
 198         chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
 199         chip->msgobj[objnr]->flags=0;
 200
 201         return 0;
 202 }
 203
 204 /**
 205  * template_program_irq - program interrupts
 206  * @candev: Pointer to candevice/board structure
 207  *
 208  * The function template_program_irq() is used for hardware that uses
 209  * programmable interrupts. If your hardware doesn't use programmable interrupts
 210  * you should not set the @candevices_t->flags entry to %PROGRAMMABLE_IRQ and
 211  * leave this function unedited. Again this function is hardware specific so
 212  * there's no example code.
 213  * Return value: The function returns zero on success or %-ENODEV on failure
 214  * File: src/template.c
 215  */
 216 int aim104_program_irq(struct candevice_t *candev)
 217 {
 218         return 0;
 219 }
 220
 221 /**
 222  * template_write_register - Low level write register routine
 223  * @data: data to be written
 224  * @address: memory address to write to
 225  *
 226  * The function template_write_register() is used to write to hardware registers
 227  * on the CAN chip. You should only have to edit this function if your hardware
 228  * uses some specific write process.
 229  * Return Value: The function does not return a value
 230  * File: src/template.c
 231  */
 232 void aim104_write_register(unsigned char data, unsigned long address)
 233 {
 234         outb(data,address);
 235 }
 236
 237 /**
 238  * template_read_register - Low level read register routine
 239  * @address: memory address to read from
 240  *
 241  * The function template_read_register() is used to read from hardware registers
 242  * on the CAN chip. You should only have to edit this function if your hardware
 243  * uses some specific read process.
 244  * Return Value: The function returns the value stored in @address
 245  * File: src/template.c
 246  */
 247 unsigned aim104_read_register(unsigned long address)
 248 {
 249         return inb(address);
 250 }
 251
 252 /* !!! Don't change this function !!! */
 253 int aim104_register(struct hwspecops_t *hwspecops)
 254 {
 255         hwspecops->request_io = aim104_request_io;
 256         hwspecops->release_io = aim104_release_io;
 257         hwspecops->reset = aim104_reset;
 258         hwspecops->init_hw_data = aim104_init_hw_data;
 259         hwspecops->init_chip_data = aim104_init_chip_data;
 260         hwspecops->init_obj_data = aim104_init_obj_data;
 261         hwspecops->write_register = aim104_write_register;
 262         hwspecops->read_register = aim104_read_register;
 263         hwspecops->program_irq = aim104_program_irq;
 264         return 0;
 265 }