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.3 17 Jun 2004
10 #include "../include/can.h"
11 #include "../include/can_sysdep.h"
12 #include "../include/main.h"
13 #include "../include/gensja1000mm.h"
14 #include "../include/sja1000p.h"
17 * IO_RANGE is the io-memory range that gets reserved, please adjust according
18 * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
19 * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
21 #define IO_RANGE 0x100
24 * gensja1000mm_request_io: - reserve io or memory range for can board
25 * @candev: pointer to candevice/board which asks for io. Field @io_addr
26 * of @candev is used in most cases to define start of the range
28 * The function gensja1000mm_request_io() is used to reserve the io-memory. If your
29 * hardware uses a dedicated memory range as hardware control registers you
30 * will have to add the code to reserve this memory as well.
31 * %IO_RANGE is the io-memory range that gets reserved, please adjust according
32 * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
33 * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
34 * Return Value: The function returns zero on success or %-ENODEV on failure
35 * File: src/gensja1000mm.c
37 int gensja1000mm_request_io(struct candevice_t *candev)
39 can_ioptr_t remap_addr;
41 if (!can_request_mem_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) {
42 CANMSG("Unable to request IO-memory: 0x%lx\n",candev->io_addr);
45 if ( !( remap_addr = ioremap( candev->io_addr, IO_RANGE ) ) ) {
46 CANMSG("Unable to access I/O memory at: 0x%lx\n", candev->io_addr);
47 can_release_mem_region(candev->io_addr,IO_RANGE);
51 can_base_addr_fixup(candev, remap_addr);
52 DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
57 * gensja1000mm_elease_io - free reserved io memory range
58 * @candev: pointer to candevice/board which releases io
60 * The function gensja1000mm_release_io() is used to free reserved io-memory.
61 * In case you have reserved more io memory, don't forget to free it here.
62 * IO_RANGE is the io-memory range that gets released, please adjust according
63 * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
64 * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
65 * Return Value: The function always returns zero
66 * File: src/gensja1000mm.c
68 int gensja1000mm_release_io(struct candevice_t *candev)
70 /* release I/O memory mapping */
71 iounmap(candev->dev_base_addr);
72 can_release_mem_region(candev->io_addr,IO_RANGE);
78 * gensja1000mm_reset - hardware reset routine
79 * @candev: Pointer to candevice/board structure
81 * The function gensja1000mm_reset() is used to give a hardware reset. This is
82 * rather hardware specific so I haven't included example code. Don't forget to
83 * check the reset status of the chip before returning.
84 * Return Value: The function returns zero on success or %-ENODEV on failure
85 * File: src/gensja1000mm.c
87 int gensja1000mm_reset(struct candevice_t *candev)
90 struct canchip_t *chip=candev->chip[0];
93 gensja1000mm_write_register(sjaMOD_RM, chip->chip_base_addr+SJAMOD);
96 cdr=gensja1000mm_read_register(chip->chip_base_addr+SJACDR);
97 gensja1000mm_write_register(cdr|sjaCDR_PELICAN, chip->chip_base_addr+SJACDR);
99 gensja1000mm_write_register(0, chip->chip_base_addr+SJAIER);
102 gensja1000mm_write_register(0, chip->chip_base_addr+SJAMOD);
103 while (gensja1000mm_read_register(chip->chip_base_addr+SJAMOD)&sjaMOD_RM){
104 if(!i--) return -ENODEV;
106 gensja1000mm_write_register(0, chip->chip_base_addr+SJAMOD);
109 cdr=gensja1000mm_read_register(chip->chip_base_addr+SJACDR);
110 gensja1000mm_write_register(cdr|sjaCDR_PELICAN, chip->chip_base_addr+SJACDR);
112 gensja1000mm_write_register(0, chip->chip_base_addr+SJAIER);
117 #define RESET_ADDR 0x0
122 * gensja1000mm_init_hw_data - Initialize hardware cards
123 * @candev: Pointer to candevice/board structure
125 * The function gensja1000mm_init_hw_data() is used to initialize the hardware
126 * structure containing information about the installed CAN-board.
127 * %RESET_ADDR represents the io-address of the hardware reset register.
128 * %NR_82527 represents the number of intel 82527 chips on the board.
129 * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
130 * The flags entry can currently only be %CANDEV_PROGRAMMABLE_IRQ to indicate that
131 * the hardware uses programmable interrupts.
132 * Return Value: The function always returns zero
133 * File: src/gensja1000mm.c
135 int gensja1000mm_init_hw_data(struct candevice_t *candev)
137 candev->res_addr=RESET_ADDR;
138 candev->nr_82527_chips=0;
139 candev->nr_sja1000_chips=1;
140 candev->nr_all_chips=1;
141 candev->flags |= CANDEV_PROGRAMMABLE_IRQ*0;
147 * gensja1000mm_init_chip_data - Initialize chips
148 * @candev: Pointer to candevice/board structure
149 * @chipnr: Number of the CAN chip on the hardware card
151 * The function gensja1000mm_init_chip_data() is used to initialize the hardware
152 * structure containing information about the CAN chips.
153 * %CHIP_TYPE represents the type of CAN chip. %CHIP_TYPE can be "i82527" or
155 * The @chip_base_addr entry represents the start of the 'official' memory map
156 * of the installed chip. It's likely that this is the same as the @io_addr
157 * argument supplied at module loading time.
158 * The @clock entry holds the chip clock value in Hz.
159 * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider
160 * register. Options defined in the %sja1000.h file:
161 * %sjaCDR_CLKOUT_MASK, %sjaCDR_CLK_OFF, %sjaCDR_RXINPEN, %sjaCDR_CBP, %sjaCDR_PELICAN
162 * The entry @sja_ocr_reg holds hardware specific options for the Output Control
163 * register. Options defined in the %sja1000.h file:
164 * %sjaOCR_MODE_BIPHASE, %sjaOCR_MODE_TEST, %sjaOCR_MODE_NORMAL, %sjaOCR_MODE_CLOCK,
165 * %sjaOCR_TX0_LH, %sjaOCR_TX1_ZZ.
166 * The entry @int_clk_reg holds hardware specific options for the Clock Out
167 * register. Options defined in the %i82527.h file:
168 * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
169 * The entry @int_bus_reg holds hardware specific options for the Bus
170 * Configuration register. Options defined in the %i82527.h file:
171 * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
172 * The entry @int_cpu_reg holds hardware specific options for the cpu interface
173 * register. Options defined in the %i82527.h file:
174 * %iCPU_CEN, %iCPU_MUX, %iCPU_SLP, %iCPU_PWD, %iCPU_DMC, %iCPU_DSC, %iCPU_RST.
175 * Return Value: The function always returns zero
176 * File: src/gensja1000mm.c
178 int gensja1000mm_init_chip_data(struct candevice_t *candev, int chipnr)
180 /*sja1000_fill_chipspecops(candev->chip[chipnr]);*/
181 sja1000p_fill_chipspecops(candev->chip[chipnr]);
183 candev->chip[chipnr]->chip_base_addr=candev->dev_base_addr;
184 if(candev->chip[chipnr]->clock<=0)
185 candev->chip[chipnr]->clock = 16000000;
186 candev->chip[chipnr]->int_clk_reg = 0x0;
187 candev->chip[chipnr]->int_bus_reg = 0x0;
188 candev->chip[chipnr]->sja_cdr_reg = sjaCDR_CBP | sjaCDR_CLK_OFF;
189 candev->chip[chipnr]->sja_ocr_reg = sjaOCR_MODE_NORMAL | sjaOCR_TX0_LH;
195 * gensja1000mm_init_obj_data - Initialize message buffers
196 * @chip: Pointer to chip specific structure
197 * @objnr: Number of the message buffer
199 * The function gensja1000mm_init_obj_data() is used to initialize the hardware
200 * structure containing information about the different message objects on the
201 * CAN chip. In case of the sja1000 there's only one message object but on the
202 * i82527 chip there are 15.
203 * The code below is for a i82527 chip and initializes the object base addresses
204 * The entry @obj_base_addr represents the first memory address of the message
205 * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
207 * Unless the hardware uses a segmented memory map, flags can be set zero.
208 * Return Value: The function always returns zero
209 * File: src/gensja1000mm.c
211 int gensja1000mm_init_obj_data(struct canchip_t *chip, int objnr)
213 chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
218 * gensja1000mm_program_irq - program interrupts
219 * @candev: Pointer to candevice/board structure
221 * The function gensja1000mm_program_irq() is used for hardware that uses
222 * programmable interrupts. If your hardware doesn't use programmable interrupts
223 * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and
224 * leave this function unedited. Again this function is hardware specific so
225 * there's no example code.
226 * Return value: The function returns zero on success or %-ENODEV on failure
227 * File: src/gensja1000mm.c
229 int gensja1000mm_program_irq(struct candevice_t *candev)
235 * gensja1000mm_write_register - Low level write register routine
236 * @data: data to be written
237 * @address: memory address to write to
239 * The function gensja1000mm_write_register() is used to write to hardware registers
240 * on the CAN chip. You should only have to edit this function if your hardware
241 * uses some specific write process.
242 * Return Value: The function does not return a value
243 * File: src/gensja1000mm.c
245 void gensja1000mm_write_register(unsigned data, can_ioptr_t address)
247 /*DEBUGMSG("gensja1000mm_write_register: addr=0x%lx data=0x%x",
249 can_writeb(data,address);
253 * gensja1000mm_read_register - Low level read register routine
254 * @address: memory address to read from
256 * The function gensja1000mm_read_register() is used to read from hardware registers
257 * on the CAN chip. You should only have to edit this function if your hardware
258 * uses some specific read process.
259 * Return Value: The function returns the value stored in @address
260 * File: src/gensja1000mm.c
262 unsigned gensja1000mm_read_register(can_ioptr_t address)
264 return can_readb(address);
267 /* !!! Don't change this function !!! */
268 int gensja1000mm_register(struct hwspecops_t *hwspecops)
270 hwspecops->request_io = gensja1000mm_request_io;
271 hwspecops->release_io = gensja1000mm_release_io;
272 hwspecops->reset = gensja1000mm_reset;
273 hwspecops->init_hw_data = gensja1000mm_init_hw_data;
274 hwspecops->init_chip_data = gensja1000mm_init_chip_data;
275 hwspecops->init_obj_data = gensja1000mm_init_obj_data;
276 hwspecops->write_register = gensja1000mm_write_register;
277 hwspecops->read_register = gensja1000mm_read_register;
278 hwspecops->program_irq = gensja1000mm_program_irq;