lincan/src/msmcan.c

   1 /* msmcan.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 "../include/can.h"
  11 #include "../include/can_sysdep.h"
  12 #include "../include/main.h"
  13 #include "../include/msmcan.h"
  14 #include "../include/i82527.h"
  15
  16 static can_spinlock_t msmcan_port_lock=SPIN_LOCK_UNLOCKED;
  17
  18 /* IO_RANGE is the io-memory range that gets reserved, please adjust according
  19  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  20  * #define IO_RANGE 0x20 for sja1000 chips.
  21  */
  22 #define IO_RANGE 0x04
  23
  24 /* The function template_request_io is used to reserve the io-memory. If your
  25  * hardware uses a dedicated memory range as hardware control registers you
  26  * will have to add the code to reserve this memory as well.
  27  * The reserved memory starts at candev->io_addr, wich is the module parameter io.
  28  */
  29 int msmcan_request_io(struct candevice_t *candev)
  30 {
  31
  32         if (!can_request_io_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
  33                 CANMSG("Unable to open port: 0x%lx\n",candev->io_addr);
  34                 return -ENODEV;
  35         } else {
  36                 DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr,
  37                          candev->io_addr + IO_RANGE - 1);
  38         }
  39         return 0;
  40 }
  41
  42 /* The function template_release_io is used to free the previously reserved
  43  * io-memory. In case you reserved more memory, don't forget to free it here.
  44  */
  45 int msmcan_release_io(struct candevice_t *candev)
  46 {
  47
  48         can_release_io_region(candev->io_addr,IO_RANGE);
  49
  50         return 0;
  51 }
  52
  53 /* The function template_reset is used to give a hardware reset. This is rather
  54  * hardware specific so I haven't included example code. Don't forget to check
  55  * the reset status of the chip before returning.
  56  */
  57 int msmcan_reset(struct candevice_t *candev)
  58 {
  59         struct chip_t *chip=candev->chip[0];
  60
  61         DEBUGMSG("Resetting msmcan hardware ...\n");
  62         /* we don't use template_write_register because we don't use the two first
  63            registers of the card but the third in order to make a hard reset */
  64         /* outb (1, msmcan_base + candev->res_addr); */
  65
  66
  67         /* terrible MSMCAN reset design - best to comment out */
  68         if(0) {
  69                 int tic=jiffies;
  70                 int tac;
  71
  72                 msmcan_write_register(iCTL_INI, chip->chip_base_addr+iCTL);
  73                 /*CLKOUT stopped (iCPU_CEN=0) */
  74                 msmcan_write_register(iCPU_DSC, chip->chip_base_addr+iCPU);
  75                 while(!(msmcan_read_register(chip->chip_base_addr+iCPU)&iCPU_CEN)){
  76                         tac=jiffies;
  77                         if((tac-tic)>HZ*2){
  78                                 CANMSG("Unable to reset board\n");
  79                                 return -EIO;
  80                         }
  81                         schedule();
  82                 }
  83
  84
  85         }
  86
  87         can_disable_irq(chip->chip_irq);
  88         msmcan_write_register(iCTL_INI, chip->chip_base_addr+iCTL);
  89         can_enable_irq(chip->chip_irq);
  90
  91         return 0;
  92 }
  93
  94 /* The function template_init_hw_data is used to initialize the hardware
  95  * structure containing information about the installed CAN-board.
  96  * RESET_ADDR represents the io-address of the hardware reset register.
  97  * NR_82527 represents the number of intel 82527 chips on the board.
  98  * NR_SJA1000 represents the number of philips sja1000 chips on the board.
  99  * The flags entry can currently only be CANDEV_PROGRAMMABLE_IRQ to indicate that
 100  * the hardware uses programmable interrupts.
 101  */
 102 #define NR_82527 1
 103 #define NR_SJA1000 0
 104
 105 int msmcan_init_hw_data(struct candevice_t *candev)
 106 {
 107         candev->res_addr=0;
 108         candev->nr_82527_chips=1;
 109         candev->nr_sja1000_chips=0;
 110         candev->nr_all_chips=1;
 111         candev->flags |= CANDEV_PROGRAMMABLE_IRQ*0;
 112
 113         return 0;
 114 }
 115
 116 /* The function template_init_chip_data is used to initialize the hardware
 117  * structure containing information about the CAN chips.
 118  * CHIP_TYPE represents the type of CAN chip. CHIP_TYPE can be "i82527" or
 119  * "sja1000".
 120  * The chip_base_addr entry represents the start of the 'official' memory map
 121  * of the installed chip. It's likely that this is the same as the candev->io_addr
 122  * argument supplied at module loading time.
 123  * The clock argument holds the chip clock value in Hz.
 124  */
 125 #define CHIP_TYPE "i82527"
 126
 127 int msmcan_init_chip_data(struct candevice_t *candev, int chipnr)
 128 {
 129         candev->chip[chipnr]->chip_type=CHIP_TYPE;
 130         /* device uses indexed access */
 131         candev->chip[chipnr]->chip_base_addr=
 132             candev->io_addr << 16;
 133         candev->chip[chipnr]->clock = 16000000;
 134         /* The CLKOUT has to be enabled to reset MSMCAN MAX1232 watchdog */
 135         candev->chip[chipnr]->int_cpu_reg = iCPU_DSC | iCPU_CEN;
 136         candev->chip[chipnr]->int_clk_reg = iCLK_SL1;
 137         candev->chip[chipnr]->int_bus_reg = iBUS_CBY;
 138
 139         return 0;
 140 }
 141
 142  /* The function template_init_obj_data is used to initialize the hardware
 143  * structure containing information about the different message objects on the
 144  * CAN chip. In case of the sja1000 there's only one message object but on the
 145  * i82527 chip there are 15.
 146  * The code below is for a i82527 chip and initializes the object base addresses
 147  * The entry obj_base_addr represents the first memory address of the message
 148  * object. In case of the sja1000 obj_base_addr is taken the same as the chips
 149  * base address.
 150  * Unless the hardware uses a segmented memory map, flags can be set zero.
 151  */
 152 int msmcan_init_obj_data(struct chip_t *chip, int objnr)
 153 {
 154
 155         chip->msgobj[objnr]->obj_base_addr=
 156             chip->chip_base_addr+(objnr+1)*0x10;
 157
 158         return 0;
 159 }
 160
 161 /* The function template_program_irq is used for hardware that uses programmable
 162  * interrupts. If your hardware doesn't use programmable interrupts you should
 163  * not set the candevices_t->flags entry to CANDEV_PROGRAMMABLE_IRQ and leave this
 164  * function unedited. Again this function is hardware specific so there's no
 165  * example code.
 166  */
 167 int msmcan_program_irq(struct candevice_t *candev)
 168 {
 169         return 0;
 170 }
 171
 172 /* The function template_write_register is used to write to hardware registers
 173  * on the CAN chip. You should only have to edit this function if your hardware
 174  * uses some specific write process.
 175  */
 176 void msmcan_write_register(unsigned char data, unsigned long address)
 177 {
 178         /* address is combination of base address shifted left by 16 and index */
 179         can_spin_irqflags_t flags;
 180
 181         /* the msmcan card has two registers, the data register at 0x0
 182            and the address register at 0x01 */
 183
 184         can_spin_lock_irqsave(&msmcan_port_lock,flags);
 185         outb(address & 0xff, (address>>16)+1);
 186         outb(data, address>>16);
 187         can_spin_unlock_irqrestore(&msmcan_port_lock,flags);
 188 }
 189
 190 /* The function template_read_register is used to read from hardware registers
 191  * on the CAN chip. You should only have to edit this function if your hardware
 192  * uses some specific read process.
 193  */
 194 unsigned msmcan_read_register(unsigned long address)
 195 {
 196         /* this is the same thing that the function write_register.
 197            We use the two register, we write the address where we
 198            want to read in a first time. In a second time we read the
 199            data */
 200         unsigned char ret;
 201         can_spin_irqflags_t flags;
 202
 203
 204         can_spin_lock_irqsave(&msmcan_port_lock,flags);
 205         outb(address & 0xff, (address>>16)+1);
 206         ret=inb(address>>16);
 207         can_spin_unlock_irqrestore(&msmcan_port_lock,flags);
 208         return ret;
 209 }
 210
 211
 212  /* !!! Don't change this function !!! */
 213 int msmcan_register(struct hwspecops_t *hwspecops)
 214 {
 215         hwspecops->request_io = msmcan_request_io;
 216         hwspecops->release_io = msmcan_release_io;
 217         hwspecops->reset = msmcan_reset;
 218         hwspecops->init_hw_data = msmcan_init_hw_data;
 219         hwspecops->init_chip_data = msmcan_init_chip_data;
 220         hwspecops->init_obj_data = msmcan_init_obj_data;
 221         hwspecops->write_register = msmcan_write_register;
 222         hwspecops->read_register = msmcan_read_register;
 223         hwspecops->program_irq = msmcan_program_irq;
 224         return 0;
 225 }