lincan/src/m437.c

   1 /* m437.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 /*
  11  * Support for the SECO M437
  12  *
  13  * SECO M437 is a pc104 format, i82527 controller based card
  14  * produced by SECO http://www.seco.it
  15  * This driver uses the Memory Mapped I/O mode, and should be
  16  * working with all cards supporting this mode.
  17  *
  18  * Written by Fabio Parodi  (fabio.parodi@iname.com)
  19  * Additional changes by Giampiero Giancipoli (gianci@freemail.it)
  20  *
  21  * Version 0.1  08 Jun 2001
  22  *
  23  */
  24
  25 #include <linux/autoconf.h>
  26
  27 #include <linux/ioport.h>
  28 #include <linux/delay.h>
  29 #include <asm/errno.h>
  30 #include <asm/io.h>
  31
  32 #include "../include/main.h"
  33 #include "../include/m437.h"
  34 #include "../include/i82527.h"
  35
  36 /*
  37  * IO_RANGE is the io-memory range that gets reserved, please adjust according
  38  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  39  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  40  */
  41 #define IO_RANGE 0x100
  42
  43
  44 static long base = 0L;
  45
  46 /**
  47  * m437_request_io: - reserve io memory
  48  * @io_addr: The reserved memory starts at @io_addr, wich is the module
  49  * parameter @io.
  50  *
  51  * The function m437_request_io() is used to reserve the io-memory. If your
  52  * hardware uses a dedicated memory range as hardware control registers you
  53  * will have to add the code to reserve this memory as well.
  54  * %IO_RANGE is the io-memory range that gets reserved, please adjust according
  55  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  56  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  57  * Return Value: The function returns zero on success or %-ENODEV on failure
  58  * File: src/m437.c
  59  */
  60 int m437_request_io(struct candevice_t *candev)
  61 {
  62
  63         if (!request_mem_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
  64                 CANMSG("Unable to request IO-memory: 0x%lx\n",candev->io_addr);
  65                 return -ENODEV;
  66         }
  67
  68         if ( !( base = (long) ioremap( candev->io_addr, IO_RANGE ) ) ) {
  69                 CANMSG("Unable to access I/O memory at: 0x%lx\n", candev->io_addr);
  70                 return -ENODEV;
  71
  72         }
  73         DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
  74         return 0;
  75 }
  76
  77 /**
  78  * m437_release_io - free reserved io-memory
  79  * @io_addr: Start of the memory range to be released.
  80  *
  81  * The function m437_release_io() is used to free reserved io-memory.
  82  * In case you have reserved more io memory, don't forget to free it here.
  83  * IO_RANGE is the io-memory range that gets released, please adjust according
  84  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  85  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  86  * Return Value: The function always returns zero
  87  * File: src/m437.c
  88  */
  89 int m437_release_io(struct candevice_t *candev)
  90 {
  91         unsigned i;
  92
  93         /* disable IRQ generation */
  94         m437_write_register(iCTL_CCE, iCTL);
  95
  96         /* clear all message objects */
  97         for (i=1; i<=15; i++) {
  98                 m437_write_register(
  99                                 INTPD_RES |
 100                                 RXIE_RES |
 101                                 TXIE_RES |
 102                                 MVAL_RES,
 103                                 i*0x10+iMSGCTL0);
 104                 m437_write_register(
 105                                 NEWD_RES |
 106                                 MLST_RES |
 107                                 CPUU_RES |
 108                                 TXRQ_RES |
 109                                 RMPD_RES,
 110                                 i*0x10+iMSGCTL1);
 111         }
 112
 113         /* power down i82527 */
 114         m437_write_register(iCPU_PWD, iCPU);
 115
 116         /* release I/O memory mapping */
 117         iounmap((void*)base);
 118
 119         release_mem_region(candev->io_addr,IO_RANGE);
 120
 121         return 0;
 122 }
 123
 124 /**
 125  * m437_reset - hardware reset routine
 126  * @card: Number of the hardware card.
 127  *
 128  * The function m437_reset() is used to give a hardware reset. This is
 129  * rather hardware specific so I haven't included example code. Don't forget to
 130  * check the reset status of the chip before returning.
 131  * Return Value: The function returns zero on success or %-ENODEV on failure
 132  * File: src/m437.c
 133  */
 134 int m437_reset(struct candevice_t *candev)
 135 {
 136         return 0;
 137 }
 138
 139 #define RESET_ADDR 0x0
 140 #define NR_82527 1
 141 #define NR_SJA1000 0
 142
 143 /**
 144  * m437_init_hw_data - Initialze hardware cards
 145  * @card: Number of the hardware card.
 146  *
 147  * The function m437_init_hw_data() is used to initialize the hardware
 148  * structure containing information about the installed CAN-board.
 149  * %RESET_ADDR represents the io-address of the hardware reset register.
 150  * %NR_82527 represents the number of intel 82527 chips on the board.
 151  * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
 152  * The flags entry can currently only be %PROGRAMMABLE_IRQ to indicate that
 153  * the hardware uses programmable interrupts.
 154  * Return Value: The function always returns zero
 155  * File: src/m437.c
 156  */
 157 int m437_init_hw_data(struct candevice_t *candev)
 158 {
 159         DEBUGMSG("m437_init_hw_data()\n");
 160         candev->res_addr=RESET_ADDR;
 161         candev->nr_82527_chips=1;
 162         candev->nr_sja1000_chips=0;
 163         candev->nr_all_chips=1;
 164         candev->flags &= ~PROGRAMMABLE_IRQ;
 165         /* The M437 has no programmable IRQ */
 166
 167         return 0;
 168 }
 169
 170 #define CHIP_TYPE "i82527"
 171 /**
 172  * m437_init_chip_data - Initialize chips
 173  * @card: Number of the hardware card
 174  * @chipnr: Number of the CAN chip on the hardware card
 175  *
 176  * The function m437_init_chip_data() is used to initialize the hardware
 177  * structure containing information about the CAN chips.
 178  * %CHIP_TYPE represents the type of CAN chip. %CHIP_TYPE can be "i82527" or
 179  * "sja1000".
 180  * The @chip_base_addr entry represents the start of the 'official' memory map
 181  * of the installed chip. It's likely that this is the same as the @io_addr
 182  * argument supplied at module loading time.
 183  * The @clock entry holds the chip clock value in Hz.
 184  * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider
 185  * register. Options defined in the %sja1000.h file:
 186  * %CDR_CLKOUT_MASK, %CDR_CLK_OFF, %CDR_RXINPEN, %CDR_CBP, %CDR_PELICAN
 187  * The entry @sja_ocr_reg holds hardware specific options for the Output Control
 188  * register. Options defined in the %sja1000.h file:
 189  * %OCR_MODE_BIPHASE, %OCR_MODE_TEST, %OCR_MODE_NORMAL, %OCR_MODE_CLOCK,
 190  * %OCR_TX0_LH, %OCR_TX1_ZZ.
 191  * The entry @int_clk_reg holds hardware specific options for the Clock Out
 192  * register. Options defined in the %i82527.h file:
 193  * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
 194  * The entry @int_bus_reg holds hardware specific options for the Bus
 195  * Configuration register. Options defined in the %i82527.h file:
 196  * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
 197  * The entry @int_cpu_reg holds hardware specific options for the cpu interface
 198  * register. Options defined in the %i82527.h file:
 199  * %iCPU_CEN, %iCPU_MUX, %iCPU_SLP, %iCPU_PWD, %iCPU_DMC, %iCPU_DSC, %iCPU_RST.
 200  * Return Value: The function always returns zero
 201  * File: src/m437.c
 202  */
 203 int m437_init_chip_data(struct candevice_t *candev, int chipnr)
 204 {
 205         candev->chip[chipnr]->chip_type=CHIP_TYPE;
 206         candev->chip[chipnr]->chip_base_addr=candev->io_addr;
 207         candev->chip[chipnr]->clock = 16000000;
 208         candev->chip[chipnr]->int_cpu_reg = iCPU_DSC | iCPU_CEN;
 209         candev->chip[chipnr]->int_clk_reg =
 210                 iCLK_CD0 | iCLK_CD1 | iCLK_CD2 | iCLK_SL0 | iCLK_SL1;
 211         candev->chip[chipnr]->int_bus_reg = iBUS_CBY;
 212
 213         return 0;
 214 }
 215
 216 /**
 217  * m437_init_obj_data - Initialize message buffers
 218  * @chipnr: Number of the CAN chip
 219  * @objnr: Number of the message buffer
 220  *
 221  * The function m437_init_obj_data() is used to initialize the hardware
 222  * structure containing information about the different message objects on the
 223  * CAN chip. In case of the sja1000 there's only one message object but on the
 224  * i82527 chip there are 15.
 225  * The code below is for a i82527 chip and initializes the object base addresses
 226  * The entry @obj_base_addr represents the first memory address of the message
 227  * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
 228  * base address.
 229  * Unless the hardware uses a segmented memory map, flags can be set zero.
 230  * Return Value: The function always returns zero
 231  * File: src/m437.c
 232  */
 233 int m437_init_obj_data(struct chip_t *chip, int objnr)
 234 {
 235         chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr+(objnr+1)*0x10;
 236         chip->msgobj[objnr]->flags=0;
 237
 238         return 0;
 239 }
 240
 241 /**
 242  * m437_program_irq - program interrupts
 243  * @card: Number of the hardware card.
 244  *
 245  * The function m437_program_irq() is used for hardware that uses
 246  * programmable interrupts. If your hardware doesn't use programmable interrupts
 247  * you should not set the @candevices_t->flags entry to %PROGRAMMABLE_IRQ and
 248  * leave this function unedited. Again this function is hardware specific so
 249  * there's no example code.
 250  * Return value: The function returns zero on success or %-ENODEV on failure
 251  * File: src/m437.c
 252  */
 253 int m437_program_irq(struct candevice_t *candev)
 254 {
 255         return 0;
 256 }
 257
 258 /**
 259  * m437_write_register - Low level write register routine
 260  * @data: data to be written
 261  * @address: memory address to write to
 262  *
 263  * The function m437_write_register() is used to write to hardware registers
 264  * on the CAN chip. You should only have to edit this function if your hardware
 265  * uses some specific write process.
 266  * Return Value: The function does not return a value
 267  * File: src/m437.c
 268  */
 269 void m437_write_register(unsigned char data, unsigned long address)
 270 {
 271         writeb(data,base+address);
 272 }
 273
 274 /**
 275  * m437_read_register - Low level read register routine
 276  * @address: memory address to read from
 277  *
 278  * The function m437_read_register() is used to read from hardware registers
 279  * on the CAN chip. You should only have to edit this function if your hardware
 280  * uses some specific read process.
 281  * Return Value: The function returns the value stored in @address
 282  * File: src/m437.c
 283  */
 284 unsigned m437_read_register(unsigned long address)
 285 {
 286         return readb(base+address);
 287 }
 288
 289 /* !!! Don't change this function !!! */
 290 int m437_register(struct hwspecops_t *hwspecops)
 291 {
 292         DEBUGMSG("m437_register()\n");
 293         hwspecops->request_io = m437_request_io;
 294         hwspecops->release_io = m437_release_io;
 295         hwspecops->reset = m437_reset;
 296         hwspecops->init_hw_data = m437_init_hw_data;
 297         hwspecops->init_chip_data = m437_init_chip_data;
 298         hwspecops->init_obj_data = m437_init_obj_data;
 299         hwspecops->write_register = m437_write_register;
 300         hwspecops->read_register = m437_read_register;
 301         hwspecops->program_irq = m437_program_irq;
 302         return 0;
 303 }