lincan/src/cc_can104.c

   1 /* cc_can104.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/cc_can104.h"
  19 #include "../include/i82527.h"
  20 #include "../include/sja1000.h"
  21
  22 /*
  23  * IO_RANGE is the io-memory range that gets reserved, please adjust according
  24  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  25  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  26  */
  27 #define IO_RANGE 0x80
  28
  29 /**
  30  * template_request_io: - reserve io memory
  31  * @io_addr: The reserved memory starts at @io_addr, wich is the module
  32  * parameter @io.
  33  *
  34  * The function template_request_io() is used to reserve the io-memory. If your
  35  * hardware uses a dedicated memory range as hardware control registers you
  36  * will have to add the code to reserve this memory as well.
  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  * Return Value: The function returns zero on success or %-ENODEV on failure
  41  * File: src/template.c
  42  */
  43 int cc104_request_io(struct candevice_t *candev)
  44 {
  45         if (!can_request_io_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
  46                 CANMSG("Unable to open port: 0x%lx\n",candev->io_addr);
  47                 return -ENODEV;
  48         }else {
  49                 DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
  50         }
  51         return 0;
  52 }
  53
  54 /**
  55  * template_release_io - free reserved io-memory
  56  * @io_addr: Start of the memory range to be released.
  57  *
  58  * The function template_release_io() is used to free reserved io-memory.
  59  * In case you have reserved more io memory, don't forget to free it here.
  60  * IO_RANGE is the io-memory range that gets released, please adjust according
  61  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  62  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
  63  * Return Value: The function always returns zero
  64  * File: src/template.c
  65  */
  66 int cc104_release_io(struct candevice_t *candev)
  67 {
  68         can_release_io_region(candev->io_addr,IO_RANGE);
  69
  70         return 0;
  71 }
  72
  73 /**
  74  * template_reset - hardware reset routine
  75  * @card: Number of the hardware card.
  76  *
  77  * The function template_reset() is used to give a hardware reset. This is
  78  * rather hardware specific so I haven't included example code. Don't forget to
  79  * check the reset status of the chip before returning.
  80  * Return Value: The function returns zero on success or %-ENODEV on failure
  81  * File: src/template.c
  82  */
  83 int cc104_reset(struct candevice_t *candev)
  84 {
  85         return 0;
  86 }
  87
  88 #define RESET_ADDR 0x0
  89 #define NR_82527 0
  90 #define NR_SJA1000 1
  91
  92 /**
  93  * template_init_hw_data - Initialze hardware cards
  94  * @card: Number of the hardware card.
  95  *
  96  * The function template_init_hw_data() is used to initialize the hardware
  97  * structure containing information about the installed CAN-board.
  98  * %RESET_ADDR represents the io-address of the hardware reset register.
  99  * %NR_82527 represents the number of intel 82527 chips on the board.
 100  * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
 101  * The flags entry can currently only be %PROGRAMMABLE_IRQ to indicate that
 102  * the hardware uses programmable interrupts.
 103  * Return Value: The function always returns zero
 104  * File: src/template.c
 105  */
 106 int cc104_init_hw_data(struct candevice_t *candev)
 107 {
 108         candev->res_addr=RESET_ADDR;
 109         candev->nr_82527_chips=0;
 110         candev->nr_sja1000_chips=1;
 111         candev->nr_all_chips=1;
 112         candev->flags &= ~PROGRAMMABLE_IRQ;
 113
 114         return 0;
 115 }
 116
 117 #define CHIP_TYPE "sja1000"
 118 /**
 119  * template_init_chip_data - Initialize chips
 120  * @card: Number of the hardware card
 121  * @chipnr: Number of the CAN chip on the hardware card
 122  *
 123  * The function template_init_chip_data() is used to initialize the hardware
 124  * structure containing information about the CAN chips.
 125  * %CHIP_TYPE represents the type of CAN chip. %CHIP_TYPE can be "i82527" or
 126  * "sja1000".
 127  * The @chip_base_addr entry represents the start of the 'official' memory map
 128  * of the installed chip. It's likely that this is the same as the @io_addr
 129  * argument supplied at module loading time.
 130  * The @clock entry holds the chip clock value in Hz.
 131  * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider
 132  * register. Options defined in the %sja1000.h file:
 133  * %CDR_CLKOUT_MASK, %CDR_CLK_OFF, %CDR_RXINPEN, %CDR_CBP, %CDR_PELICAN
 134  * The entry @sja_ocr_reg holds hardware specific options for the Output Control
 135  * register. Options defined in the %sja1000.h file:
 136  * %OCR_MODE_BIPHASE, %OCR_MODE_TEST, %OCR_MODE_NORMAL, %OCR_MODE_CLOCK,
 137  * %OCR_TX0_LH, %OCR_TX1_ZZ.
 138  * The entry @int_clk_reg holds hardware specific options for the Clock Out
 139  * register. Options defined in the %i82527.h file:
 140  * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
 141  * The entry @int_bus_reg holds hardware specific options for the Bus
 142  * Configuration register. Options defined in the %i82527.h file:
 143  * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
 144  * Return Value: The function always returns zero
 145  * File: src/template.c
 146  */
 147 int cc104_init_chip_data(struct candevice_t *candev, int chipnr)
 148 {
 149         candev->chip[chipnr]->chip_type=CHIP_TYPE;
 150         candev->chip[chipnr]->chip_base_addr=candev->io_addr;
 151         candev->chip[chipnr]->clock = 16000000;
 152         candev->chip[chipnr]->flags = 0;
 153         candev->chip[chipnr]->sja_cdr_reg = CDR_CBP | CDR_CLK_OFF;
 154         candev->chip[chipnr]->sja_ocr_reg = OCR_MODE_NORMAL |
 155                                                                 OCR_TX0_LH;
 156
 157         return 0;
 158 }
 159
 160 /**
 161  * template_init_obj_data - Initialize message buffers
 162  * @chipnr: Number of the CAN chip
 163  * @objnr: Number of the message buffer
 164  *
 165  * The function template_init_obj_data() is used to initialize the hardware
 166  * structure containing information about the different message objects on the
 167  * CAN chip. In case of the sja1000 there's only one message object but on the
 168  * i82527 chip there are 15.
 169  * The code below is for a i82527 chip and initializes the object base addresses
 170  * The entry @obj_base_addr represents the first memory address of the message
 171  * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
 172  * base address.
 173  * Unless the hardware uses a segmented memory map, flags can be set zero.
 174  * Return Value: The function always returns zero
 175  * File: src/template.c
 176  */
 177 int cc104_init_obj_data(struct chip_t *chip, int objnr)
 178 {
 179         chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
 180         chip->msgobj[objnr]->flags=0;
 181
 182         return 0;
 183 }
 184
 185 /**
 186  * template_program_irq - program interrupts
 187  * @card: Number of the hardware card.
 188  *
 189  * The function template_program_irq() is used for hardware that uses
 190  * programmable interrupts. If your hardware doesn't use programmable interrupts
 191  * you should not set the @candevices_t->flags entry to %PROGRAMMABLE_IRQ and
 192  * leave this function unedited. Again this function is hardware specific so
 193  * there's no example code.
 194  * Return value: The function returns zero on success or %-ENODEV on failure
 195  * File: src/template.c
 196  */
 197 int cc104_program_irq(struct candevice_t *candev)
 198 {
 199         return 0;
 200 }
 201
 202 /**
 203  * template_write_register - Low level write register routine
 204  * @data: data to be written
 205  * @address: memory address to write to
 206  *
 207  * The function template_write_register() is used to write to hardware registers
 208  * on the CAN chip. You should only have to edit this function if your hardware
 209  * uses some specific write process.
 210  * Return Value: The function does not return a value
 211  * File: src/template.c
 212  */
 213 void cc104_write_register(unsigned char data, unsigned long address)
 214 {
 215         outb(data,address);
 216 }
 217
 218 /**
 219  * template_read_register - Low level read register routine
 220  * @address: memory address to read from
 221  *
 222  * The function template_read_register() is used to read from hardware registers
 223  * on the CAN chip. You should only have to edit this function if your hardware
 224  * uses some specific read process.
 225  * Return Value: The function returns the value stored in @address
 226  * File: src/template.c
 227  */
 228 unsigned cc104_read_register(unsigned long address)
 229 {
 230         return inb(address);
 231 }
 232
 233 /* !!! Don't change this function !!! */
 234 int cc104_register(struct hwspecops_t *hwspecops)
 235 {
 236         hwspecops->request_io = cc104_request_io;
 237         hwspecops->release_io = cc104_release_io;
 238         hwspecops->reset = cc104_reset;
 239         hwspecops->init_hw_data = cc104_init_hw_data;
 240         hwspecops->init_chip_data = cc104_init_chip_data;
 241         hwspecops->init_obj_data = cc104_init_obj_data;
 242         hwspecops->write_register = cc104_write_register;
 243         hwspecops->read_register = cc104_read_register;
 244         hwspecops->program_irq = cc104_program_irq;
 245         return 0;
 246 }