lincan/src/gensja1000io.c

   1 /**************************************************************************/
   2 /* File: gensja1000io.c -  sja1000 I/O mapped cards (PCAN-PC/104 etc)     */
   3 /*                                                                        */
   4 /* LinCAN - (Not only) Linux CAN bus driver                               */
   5 /* Copyright (C) 2002-2009 DCE FEE CTU Prague <http://dce.felk.cvut.cz>   */
   6 /* Copyright (C) 2002-2009 Pavel Pisa <pisa@cmp.felk.cvut.cz>             */
   7 /* Funded by OCERA and FRESCOR IST projects                               */
   8 /* Based on CAN driver code by Arnaud Westenberg <arnaud@wanadoo.nl>      */
   9 /*                                                                        */
  10 /* LinCAN is free software; you can redistribute it and/or modify it      */
  11 /* under terms of the GNU General Public License as published by the      */
  12 /* Free Software Foundation; either version 2, or (at your option) any    */
  13 /* later version.  LinCAN is distributed in the hope that it will be      */
  14 /* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
  15 /* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
  16 /* General Public License for more details. You should have received a    */
  17 /* copy of the GNU General Public License along with LinCAN; see file     */
  18 /* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
  19 /* Cambridge, MA 02139, USA.                                              */
  20 /*                                                                        */
  21 /* To allow use of LinCAN in the compact embedded systems firmware        */
  22 /* and RT-executives (RTEMS for example), main authors agree with next    */
  23 /* special exception:                                                     */
  24 /*                                                                        */
  25 /* Including LinCAN header files in a file, instantiating LinCAN generics */
  26 /* or templates, or linking other files with LinCAN objects to produce    */
  27 /* an application image/executable, does not by itself cause the          */
  28 /* resulting application image/executable to be covered by                */
  29 /* the GNU General Public License.                                        */
  30 /* This exception does not however invalidate any other reasons           */
  31 /* why the executable file might be covered by the GNU Public License.    */
  32 /* Publication of enhanced or derived LinCAN files is required although.  */
  33 /**************************************************************************/
  34
  35 #include "../include/can.h"
  36 #include "../include/can_sysdep.h"
  37 #include "../include/main.h"
  38 #include "../include/gensja1000io.h"
  39 #include "../include/sja1000p.h"
  40
  41 /*
  42  * IO_RANGE is the io-memory range that gets reserved, please adjust according
  43  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  44  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  45  */
  46 #define IO_RANGE 0x20
  47
  48 /**
  49  * gensja1000io_request_io: - reserve io or memory range for can board
  50  * @candev: pointer to candevice/board which asks for io. Field @io_addr
  51  *      of @candev is used in most cases to define start of the range
  52  *
  53  * The function gensja1000io_request_io() is used to reserve the io-memory. If your
  54  * hardware uses a dedicated memory range as hardware control registers you
  55  * will have to add the code to reserve this memory as well.
  56  * %IO_RANGE is the io-memory range that gets reserved, please adjust according
  57  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  58  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  59  * Return Value: The function returns zero on success or %-ENODEV on failure
  60  * File: src/gensja1000io.c
  61  */
  62 int gensja1000io_request_io(struct candevice_t *candev)
  63 {
  64         if (!can_request_io_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
  65                 CANMSG("Unable to open port: 0x%lx\n",candev->io_addr);
  66                 return -ENODEV;
  67         }else {
  68                 DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
  69         }
  70         return 0;
  71 }
  72
  73 /**
  74  * gensja1000io_elease_io - free reserved io memory range
  75  * @candev: pointer to candevice/board which releases io
  76  *
  77  * The function gensja1000io_release_io() is used to free reserved io-memory.
  78  * In case you have reserved more io memory, don't forget to free it here.
  79  * IO_RANGE is the io-memory range that gets released, please adjust according
  80  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  81  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  82  * Return Value: The function always returns zero
  83  * File: src/gensja1000io.c
  84  */
  85 int gensja1000io_release_io(struct candevice_t *candev)
  86 {
  87         can_release_io_region(candev->io_addr,IO_RANGE);
  88
  89         return 0;
  90 }
  91
  92 /**
  93  * gensja1000io_reset - hardware reset routine
  94  * @candev: Pointer to candevice/board structure
  95  *
  96  * The function gensja1000io_reset() is used to give a hardware reset. This is
  97  * rather hardware specific so I haven't included example code. Don't forget to
  98  * check the reset status of the chip before returning.
  99  * Return Value: The function returns zero on success or %-ENODEV on failure
 100  * File: src/gensja1000io.c
 101  */
 102 int gensja1000io_reset(struct candevice_t *candev)
 103 {
 104         int i;
 105         struct canchip_t *chip=candev->chip[0];
 106         unsigned cdr;
 107
 108         gensja1000io_write_register(sjaMOD_RM, chip->chip_base_addr+SJAMOD);
 109         udelay(1000);
 110
 111         cdr=gensja1000io_read_register(chip->chip_base_addr+SJACDR);
 112         gensja1000io_write_register(cdr|sjaCDR_PELICAN, chip->chip_base_addr+SJACDR);
 113
 114         gensja1000io_write_register(0, chip->chip_base_addr+SJAIER);
 115
 116         i=20;
 117         gensja1000io_write_register(0, chip->chip_base_addr+SJAMOD);
 118         while (gensja1000io_read_register(chip->chip_base_addr+SJAMOD)&sjaMOD_RM){
 119                 if(!i--) return -ENODEV;
 120                 udelay(1000);
 121                 gensja1000io_write_register(0, chip->chip_base_addr+SJAMOD);
 122         }
 123
 124         cdr=gensja1000io_read_register(chip->chip_base_addr+SJACDR);
 125         gensja1000io_write_register(cdr|sjaCDR_PELICAN, chip->chip_base_addr+SJACDR);
 126
 127         gensja1000io_write_register(0, chip->chip_base_addr+SJAIER);
 128
 129         return 0;
 130 }
 131
 132 #define RESET_ADDR 0x0
 133 #define NR_82527 0
 134 #define NR_SJA1000 1
 135
 136 /**
 137  * gensja1000io_init_hw_data - Initialize hardware cards
 138  * @candev: Pointer to candevice/board structure
 139  *
 140  * The function gensja1000io_init_hw_data() is used to initialize the hardware
 141  * structure containing information about the installed CAN-board.
 142  * %RESET_ADDR represents the io-address of the hardware reset register.
 143  * %NR_82527 represents the number of intel 82527 chips on the board.
 144  * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
 145  * The flags entry can currently only be %CANDEV_PROGRAMMABLE_IRQ to indicate that
 146  * the hardware uses programmable interrupts.
 147  * Return Value: The function always returns zero
 148  * File: src/gensja1000io.c
 149  */
 150 int gensja1000io_init_hw_data(struct candevice_t *candev)
 151 {
 152         candev->res_addr=RESET_ADDR;
 153         candev->nr_82527_chips=0;
 154         candev->nr_sja1000_chips=1;
 155         candev->nr_all_chips=1;
 156         candev->flags |= CANDEV_PROGRAMMABLE_IRQ*0;
 157
 158         return 0;
 159 }
 160
 161 /**
 162  * gensja1000io_init_chip_data - Initialize chips
 163  * @candev: Pointer to candevice/board structure
 164  * @chipnr: Number of the CAN chip on the hardware card
 165  *
 166  * The function gensja1000io_init_chip_data() is used to initialize the hardware
 167  * structure containing information about the CAN chips.
 168  * %CHIP_TYPE represents the type of CAN chip. %CHIP_TYPE can be "i82527" or
 169  * "sja1000".
 170  * The @chip_base_addr entry represents the start of the 'official' memory map
 171  * of the installed chip. It's likely that this is the same as the @io_addr
 172  * argument supplied at module loading time.
 173  * The @clock entry holds the chip clock value in Hz.
 174  * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider
 175  * register. Options defined in the %sja1000.h file:
 176  * %sjaCDR_CLKOUT_MASK, %sjaCDR_CLK_OFF, %sjaCDR_RXINPEN, %sjaCDR_CBP, %sjaCDR_PELICAN
 177  * The entry @sja_ocr_reg holds hardware specific options for the Output Control
 178  * register. Options defined in the %sja1000.h file:
 179  * %sjaOCR_MODE_BIPHASE, %sjaOCR_MODE_TEST, %sjaOCR_MODE_NORMAL, %sjaOCR_MODE_CLOCK,
 180  * %sjaOCR_TX0_LH, %sjaOCR_TX1_ZZ.
 181  * The entry @int_clk_reg holds hardware specific options for the Clock Out
 182  * register. Options defined in the %i82527.h file:
 183  * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
 184  * The entry @int_bus_reg holds hardware specific options for the Bus
 185  * Configuration register. Options defined in the %i82527.h file:
 186  * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
 187  * The entry @int_cpu_reg holds hardware specific options for the cpu interface
 188  * register. Options defined in the %i82527.h file:
 189  * %iCPU_CEN, %iCPU_MUX, %iCPU_SLP, %iCPU_PWD, %iCPU_DMC, %iCPU_DSC, %iCPU_RST.
 190  * Return Value: The function always returns zero
 191  * File: src/gensja1000io.c
 192  */
 193 int gensja1000io_init_chip_data(struct candevice_t *candev, int chipnr)
 194 {
 195         /*sja1000_fill_chipspecops(candev->chip[chipnr]);*/
 196         sja1000p_fill_chipspecops(candev->chip[chipnr]);
 197
 198         candev->chip[chipnr]->chip_base_addr=can_ioport2ioptr(candev->io_addr);
 199         if(candev->chip[chipnr]->clock<=0)
 200                 candev->chip[chipnr]->clock = 16000000;
 201         candev->chip[chipnr]->int_clk_reg = 0x0;
 202         candev->chip[chipnr]->int_bus_reg = 0x0;
 203         candev->chip[chipnr]->sja_cdr_reg = sjaCDR_CBP | sjaCDR_CLK_OFF;
 204         candev->chip[chipnr]->sja_ocr_reg = sjaOCR_MODE_NORMAL | sjaOCR_TX0_LH;
 205
 206         return 0;
 207 }
 208
 209 /**
 210  * gensja1000io_init_obj_data - Initialize message buffers
 211  * @chip: Pointer to chip specific structure
 212  * @objnr: Number of the message buffer
 213  *
 214  * The function gensja1000io_init_obj_data() is used to initialize the hardware
 215  * structure containing information about the different message objects on the
 216  * CAN chip. In case of the sja1000 there's only one message object but on the
 217  * i82527 chip there are 15.
 218  * The code below is for a i82527 chip and initializes the object base addresses
 219  * The entry @obj_base_addr represents the first memory address of the message
 220  * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
 221  * base address.
 222  * Unless the hardware uses a segmented memory map, flags can be set zero.
 223  * Return Value: The function always returns zero
 224  * File: src/gensja1000io.c
 225  */
 226 int gensja1000io_init_obj_data(struct canchip_t *chip, int objnr)
 227 {
 228         chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
 229         return 0;
 230 }
 231
 232 /**
 233  * gensja1000io_program_irq - program interrupts
 234  * @candev: Pointer to candevice/board structure
 235  *
 236  * The function gensja1000io_program_irq() is used for hardware that uses
 237  * programmable interrupts. If your hardware doesn't use programmable interrupts
 238  * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and
 239  * leave this function unedited. Again this function is hardware specific so
 240  * there's no example code.
 241  * Return value: The function returns zero on success or %-ENODEV on failure
 242  * File: src/gensja1000io.c
 243  */
 244 int gensja1000io_program_irq(struct candevice_t *candev)
 245 {
 246         return 0;
 247 }
 248
 249 /**
 250  * gensja1000io_write_register - Low level write register routine
 251  * @data: data to be written
 252  * @address: memory address to write to
 253  *
 254  * The function gensja1000io_write_register() is used to write to hardware registers
 255  * on the CAN chip. You should only have to edit this function if your hardware
 256  * uses some specific write process.
 257  * Return Value: The function does not return a value
 258  * File: src/gensja1000io.c
 259  */
 260 void gensja1000io_write_register(unsigned data, can_ioptr_t address)
 261 {
 262         /*DEBUGMSG("gensja1000io_write_register: addr=0x%lx data=0x%x",
 263                 address,data);*/
 264         can_outb(data,address);
 265 }
 266
 267 /**
 268  * gensja1000io_read_register - Low level read register routine
 269  * @address: memory address to read from
 270  *
 271  * The function gensja1000io_read_register() is used to read from hardware registers
 272  * on the CAN chip. You should only have to edit this function if your hardware
 273  * uses some specific read process.
 274  * Return Value: The function returns the value stored in @address
 275  * File: src/gensja1000io.c
 276  */
 277 unsigned gensja1000io_read_register(can_ioptr_t address)
 278 {
 279         return can_inb(address);
 280 }
 281
 282 /* !!! Don't change this function !!! */
 283 int gensja1000io_register(struct hwspecops_t *hwspecops)
 284 {
 285         hwspecops->request_io = gensja1000io_request_io;
 286         hwspecops->release_io = gensja1000io_release_io;
 287         hwspecops->reset = gensja1000io_reset;
 288         hwspecops->init_hw_data = gensja1000io_init_hw_data;
 289         hwspecops->init_chip_data = gensja1000io_init_chip_data;
 290         hwspecops->init_obj_data = gensja1000io_init_obj_data;
 291         hwspecops->write_register = gensja1000io_write_register;
 292         hwspecops->read_register = gensja1000io_read_register;
 293         hwspecops->program_irq = gensja1000io_program_irq;
 294         return 0;
 295 }