1 /**************************************************************************/
2 /* File: aim104.c - AIM104CAN PC/104 card by Arcom Control Systems */
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> */
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. */
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: */
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 /**************************************************************************/
35 #include "../include/can.h"
36 #include "../include/can_sysdep.h"
37 #include "../include/main.h"
38 #include "../include/aim104.h"
39 #include "../include/sja1000.h"
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.
49 * template_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
53 * The function template_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/template.c
62 int aim104_request_io(struct candevice_t *candev)
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);
68 DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1);
74 * template_elease_io - free reserved io memory range
75 * @candev: pointer to candevice/board which releases io
77 * The function template_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/template.c
85 int aim104_release_io(struct candevice_t *candev)
87 can_release_io_region(candev->io_addr,IO_RANGE);
93 * template_reset - hardware reset routine
94 * @candev: Pointer to candevice/board structure
96 * The function template_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/template.c
102 int aim104_reset(struct candevice_t *candev)
106 DEBUGMSG("Resetting aim104 hardware ...\n");
108 aim104_write_register(0x00, candev->io_addr + SJACR);
110 /* Check hardware reset status chip 0 */
112 while ( (aim104_read_register(candev->io_addr + SJACR)
113 & sjaCR_RR) && (i<=15) ) {
118 CANMSG("Reset status timeout!\n");
119 CANMSG("Please check your hardware.\n");
123 DEBUGMSG("Chip reset status ok.\n");
128 #define RESET_ADDR 0x0
133 * template_init_hw_data - Initialize hardware cards
134 * @candev: Pointer to candevice/board structure
136 * The function template_init_hw_data() is used to initialize the hardware
137 * structure containing information about the installed CAN-board.
138 * %RESET_ADDR represents the io-address of the hardware reset register.
139 * %NR_82527 represents the number of intel 82527 chips on the board.
140 * %NR_SJA1000 represents the number of philips sja1000 chips on the board.
141 * The flags entry can currently only be %CANDEV_PROGRAMMABLE_IRQ to indicate that
142 * the hardware uses programmable interrupts.
143 * Return Value: The function always returns zero
144 * File: src/template.c
146 int aim104_init_hw_data(struct candevice_t *candev)
148 candev->res_addr=RESET_ADDR;
149 candev->nr_82527_chips=0;
150 candev->nr_sja1000_chips=1;
151 candev->nr_all_chips=1;
152 candev->flags &= ~CANDEV_PROGRAMMABLE_IRQ;
158 * template_init_chip_data - Initialize chips
159 * @candev: Pointer to candevice/board structure
160 * @chipnr: Number of the CAN chip on the hardware card
162 * The function template_init_chip_data() is used to initialize the hardware
163 * structure containing information about the CAN chips.
164 * %CHIP_TYPE represents the type of CAN chip. %CHIP_TYPE can be "i82527" or
166 * The @chip_base_addr entry represents the start of the 'official' memory map
167 * of the installed chip. It's likely that this is the same as the @io_addr
168 * argument supplied at module loading time.
169 * The @clock entry holds the chip clock value in Hz.
170 * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider
171 * register. Options defined in the %sja1000.h file:
172 * %sjaCDR_CLKOUT_MASK, %sjaCDR_CLK_OFF, %sjaCDR_RXINPEN, %sjaCDR_CBP, %sjaCDR_PELICAN
173 * The entry @sja_ocr_reg holds hardware specific options for the Output Control
174 * register. Options defined in the %sja1000.h file:
175 * %sjaOCR_MODE_BIPHASE, %sjaOCR_MODE_TEST, %sjaOCR_MODE_NORMAL, %sjaOCR_MODE_CLOCK,
176 * %sjaOCR_TX0_LH, %sjaOCR_TX1_ZZ.
177 * The entry @int_clk_reg holds hardware specific options for the Clock Out
178 * register. Options defined in the %i82527.h file:
179 * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
180 * The entry @int_bus_reg holds hardware specific options for the Bus
181 * Configuration register. Options defined in the %i82527.h file:
182 * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
183 * Return Value: The function always returns zero
184 * File: src/template.c
186 int aim104_init_chip_data(struct candevice_t *candev, int chipnr)
188 sja1000_fill_chipspecops(candev->chip[chipnr]);
189 candev->chip[chipnr]->chip_base_addr=can_ioport2ioptr(candev->io_addr);
190 candev->chip[chipnr]->clock = 16000000;
191 candev->chip[chipnr]->flags = 0;
192 candev->chip[chipnr]->sja_cdr_reg = 0x08;
193 candev->chip[chipnr]->sja_ocr_reg = 0xfa;
199 * template_init_obj_data - Initialize message buffers
200 * @chip: Pointer to chip specific structure
201 * @objnr: Number of the message buffer
203 * The function template_init_obj_data() is used to initialize the hardware
204 * structure containing information about the different message objects on the
205 * CAN chip. In case of the sja1000 there's only one message object but on the
206 * i82527 chip there are 15.
207 * The code below is for a i82527 chip and initializes the object base addresses
208 * The entry @obj_base_addr represents the first memory address of the message
209 * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
211 * Unless the hardware uses a segmented memory map, flags can be set zero.
212 * Return Value: The function always returns zero
213 * File: src/template.c
215 int aim104_init_obj_data(struct canchip_t *chip, int objnr)
217 chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr;
218 chip->msgobj[objnr]->obj_flags=0;
224 * template_program_irq - program interrupts
225 * @candev: Pointer to candevice/board structure
227 * The function template_program_irq() is used for hardware that uses
228 * programmable interrupts. If your hardware doesn't use programmable interrupts
229 * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and
230 * leave this function unedited. Again this function is hardware specific so
231 * there's no example code.
232 * Return value: The function returns zero on success or %-ENODEV on failure
233 * File: src/template.c
235 int aim104_program_irq(struct candevice_t *candev)
241 * template_write_register - Low level write register routine
242 * @data: data to be written
243 * @address: memory address to write to
245 * The function template_write_register() is used to write to hardware registers
246 * on the CAN chip. You should only have to edit this function if your hardware
247 * uses some specific write process.
248 * Return Value: The function does not return a value
249 * File: src/template.c
251 void aim104_write_register(unsigned data, can_ioptr_t address)
253 can_outb(data,address);
257 * template_read_register - Low level read register routine
258 * @address: memory address to read from
260 * The function template_read_register() is used to read from hardware registers
261 * on the CAN chip. You should only have to edit this function if your hardware
262 * uses some specific read process.
263 * Return Value: The function returns the value stored in @address
264 * File: src/template.c
266 unsigned aim104_read_register(can_ioptr_t address)
268 return can_inb(address);
271 /* !!! Don't change this function !!! */
272 int aim104_register(struct hwspecops_t *hwspecops)
274 hwspecops->request_io = aim104_request_io;
275 hwspecops->release_io = aim104_release_io;
276 hwspecops->reset = aim104_reset;
277 hwspecops->init_hw_data = aim104_init_hw_data;
278 hwspecops->init_chip_data = aim104_init_chip_data;
279 hwspecops->init_obj_data = aim104_init_obj_data;
280 hwspecops->write_register = aim104_write_register;
281 hwspecops->read_register = aim104_read_register;
282 hwspecops->program_irq = aim104_program_irq;