Structured comments updated.
[lincan.git] / lincan / src / template.c
1 /* template.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 /* This file is intended as a template file for currently unsupported hardware.
11  * Once you've changed/added the functions specific to your hardware it is
12  * possible to load the driver with the hardware option hw=template.
13  */
14
15 #include "../include/can.h"
16 #include "../include/can_sysdep.h"
17 #include "../include/main.h"
18 #include "../include/template.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 0x100
28
29 /**
30  * template_request_io: - reserve io or memory range for can board
31  * @candev: pointer to candevice/board which asks for io. Field @io_addr
32  *      of @candev is used in most cases to define start of the range
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 template_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 range
56  * @candev: pointer to candevice/board which releases io
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 template_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  * @candev: Pointer to candevice/board structure
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 template_reset(struct candevice_t *candev)
84 {
85         return 0;
86 }
87
88 #define RESET_ADDR 0x0
89 #define NR_82527 1
90 #define NR_SJA1000 0
91
92 /**
93  * template_init_hw_data - Initialize hardware cards
94  * @candev: Pointer to candevice/board structure
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 %CANDEV_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 template_init_hw_data(struct candevice_t *candev) 
107 {
108         candev->res_addr=RESET_ADDR;
109         candev->nr_82527_chips=NR_82527;
110         candev->nr_sja1000_chips=NR_SJA1000;
111         candev->nr_all_chips=NR_82527+NR_SJA1000;
112         candev->flags |= CANDEV_PROGRAMMABLE_IRQ;
113
114         return 0;
115 }
116
117 #define CHIP_TYPE "i82527"
118 /**
119  * template_init_chip_data - Initialize chips
120  * @candev: Pointer to candevice/board structure
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  * The entry @int_cpu_reg holds hardware specific options for the cpu interface
145  * register. Options defined in the %i82527.h file:
146  * %iCPU_CEN, %iCPU_MUX, %iCPU_SLP, %iCPU_PWD, %iCPU_DMC, %iCPU_DSC, %iCPU_RST.
147  * Return Value: The function always returns zero
148  * File: src/template.c
149  */
150 int template_init_chip_data(struct candevice_t *candev, int chipnr)
151 {
152         candev->chip[chipnr]->chip_type=CHIP_TYPE;
153         candev->chip[chipnr]->chip_base_addr=candev->io_addr;
154         candev->chip[chipnr]->clock = 16000000;
155         candev->chip[chipnr]->int_cpu_reg = iCPU_DSC;
156         candev->chip[chipnr]->int_clk_reg = iCLK_SL1;
157         candev->chip[chipnr]->int_bus_reg = iBUS_CBY;
158         candev->chip[chipnr]->sja_cdr_reg = CDR_CBP | CDR_CLK_OFF;
159         candev->chip[chipnr]->sja_ocr_reg = OCR_MODE_NORMAL |
160                                                                 OCR_TX0_LH;
161
162         return 0;
163 }
164
165 /**
166  * template_init_obj_data - Initialize message buffers
167  * @chip: Pointer to chip specific structure
168  * @objnr: Number of the message buffer
169  *
170  * The function template_init_obj_data() is used to initialize the hardware
171  * structure containing information about the different message objects on the
172  * CAN chip. In case of the sja1000 there's only one message object but on the
173  * i82527 chip there are 15.
174  * The code below is for a i82527 chip and initializes the object base addresses
175  * The entry @obj_base_addr represents the first memory address of the message 
176  * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
177  * base address.
178  * Unless the hardware uses a segmented memory map, flags can be set zero.
179  * Return Value: The function always returns zero
180  * File: src/template.c
181  */
182 int template_init_obj_data(struct chip_t *chip, int objnr)
183 {
184         chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr+(objnr+1)*0x10;
185         
186         return 0;
187 }
188
189 /**
190  * template_program_irq - program interrupts
191  * @candev: Pointer to candevice/board structure
192  *
193  * The function template_program_irq() is used for hardware that uses 
194  * programmable interrupts. If your hardware doesn't use programmable interrupts
195  * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and 
196  * leave this function unedited. Again this function is hardware specific so 
197  * there's no example code.
198  * Return value: The function returns zero on success or %-ENODEV on failure
199  * File: src/template.c
200  */
201 int template_program_irq(struct candevice_t *candev)
202 {
203         return 0;
204 }
205
206 /**
207  * template_write_register - Low level write register routine
208  * @data: data to be written
209  * @address: memory address to write to
210  *
211  * The function template_write_register() is used to write to hardware registers
212  * on the CAN chip. You should only have to edit this function if your hardware
213  * uses some specific write process.
214  * Return Value: The function does not return a value
215  * File: src/template.c
216  */
217 void template_write_register(unsigned char data, unsigned long address)
218 {
219         outb(data,address);
220 }
221
222 /**
223  * template_read_register - Low level read register routine
224  * @address: memory address to read from
225  *
226  * The function template_read_register() is used to read from hardware registers
227  * on the CAN chip. You should only have to edit this function if your hardware
228  * uses some specific read process.
229  * Return Value: The function returns the value stored in @address
230  * File: src/template.c
231  */
232 unsigned template_read_register(unsigned long address)
233 {
234         return inb(address);
235 }
236
237 /* !!! Don't change this function !!! */
238 int template_register(struct hwspecops_t *hwspecops)
239 {
240         hwspecops->request_io = template_request_io;
241         hwspecops->release_io = template_release_io;
242         hwspecops->reset = template_reset;
243         hwspecops->init_hw_data = template_init_hw_data;
244         hwspecops->init_chip_data = template_init_chip_data;
245         hwspecops->init_obj_data = template_init_obj_data;
246         hwspecops->write_register = template_write_register;
247         hwspecops->read_register = template_read_register;
248         hwspecops->program_irq = template_program_irq;
249         return 0;
250 }