]> rtime.felk.cvut.cz Git - lincan.git/blobdiff - lincan/src/bfadcan.c
The LinCAN driver license unified according to DCE FEE CTU head and superiors request.
[lincan.git] / lincan / src / bfadcan.c
index 75294ec464142f6ef738bc19e1d6d1565472f07f..5557ca1d74c283f237d87d74ec751c4422754f3e 100644 (file)
@@ -1,17 +1,36 @@
-/* bfadcan.c
- * Linux CAN-bus device driver.
- * Written by Arnaud Westenberg email:arnaud@wanadoo.nl
- * Rewritten for new CAN queues by Pavel Pisa - OCERA team member
- * email:pisa@cmp.felk.cvut.cz
- * This software is released under the GPL-License.
- * Version lincan-0.3  17 Jun 2004
- */ 
-
-/* This file is intended as a bfadcan file for currently unsupported hardware.
- * Once you've changed/added the functions specific to your hardware it is
- * possible to load the driver with the hardware option hw=bfadcan.
- */
-
+/**************************************************************************/
+/* File: bfadcan.c - support for BFAD can boards                          */
+/*                                                                        */
+/* LinCAN - (Not only) Linux CAN bus driver                               */
+/* Copyright (C) 2002-2009 DCE FEE CTU Prague <http://dce.felk.cvut.cz>   */
+/* Copyright (C) 2002-2009 Pavel Pisa <pisa@cmp.felk.cvut.cz>             */
+/* Funded by OCERA and FRESCOR IST projects                               */
+/* Based on CAN driver code by Arnaud Westenberg <arnaud@wanadoo.nl>      */
+/*                                                                        */
+/* LinCAN is free software; you can redistribute it and/or modify it      */
+/* under terms of the GNU General Public License as published by the      */
+/* Free Software Foundation; either version 2, or (at your option) any    */
+/* later version.  LinCAN is distributed in the hope that it will be      */
+/* useful, but WITHOUT ANY WARRANTY; without even the implied warranty    */
+/* of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU    */
+/* General Public License for more details. You should have received a    */
+/* copy of the GNU General Public License along with LinCAN; see file     */
+/* COPYING. If not, write to the Free Software Foundation, 675 Mass Ave,  */
+/* Cambridge, MA 02139, USA.                                              */
+/*                                                                        */
+/* To allow use of LinCAN in the compact embedded systems firmware        */
+/* and RT-executives (RTEMS for example), main authors agree with next    */
+/* special exception:                                                     */
+/*                                                                        */
+/* Including LinCAN header files in a file, instantiating LinCAN generics */
+/* or templates, or linking other files with LinCAN objects to produce    */
+/* an application image/executable, does not by itself cause the          */
+/* resulting application image/executable to be covered by                */
+/* the GNU General Public License.                                        */
+/* This exception does not however invalidate any other reasons           */
+/* why the executable file might be covered by the GNU Public License.    */
+/* Publication of enhanced or derived LinCAN files is required although.  */
+/**************************************************************************/
 
 #define WINDOWED_ACCESS
 
@@ -52,7 +71,7 @@ void bfadcan_write_register(unsigned data, can_ioptr_t address);
  *
  * The function bfadcan_request_io() is used to reserve the io-memory. If your
  * hardware uses a dedicated memory range as hardware control registers you
- * will have to add the code to reserve this memory as well. 
+ * will have to add the code to reserve this memory as well.
  * %IO_RANGE is the io-memory range that gets reserved, please adjust according
  * your hardware. Example: #define IO_RANGE 0x100 for i82527 chips or
  * #define IO_RANGE 0x20 for sja1000 chips in basic CAN mode.
@@ -93,8 +112,8 @@ int bfadcan_release_io(struct candevice_t *candev)
  * bfadcan_reset - hardware reset routine
  * @candev: Pointer to candevice/board structure
  *
- * The function bfadcan_reset() is used to give a hardware reset. This is 
- * rather hardware specific so I haven't included example code. Don't forget to 
+ * The function bfadcan_reset() is used to give a hardware reset. This is
+ * rather hardware specific so I haven't included example code. Don't forget to
  * check the reset status of the chip before returning.
  * Return Value: The function returns zero on success or %-ENODEV on failure
  * File: src/bfadcan.c
@@ -105,10 +124,10 @@ int bfadcan_reset(struct candevice_t *candev)
        int i;
        struct canchip_t *chip=candev->chip[0];
        unsigned cdr;
-       
+
        bfadcan_write_register(sjaMOD_RM, chip->chip_base_addr+SJAMOD);
        udelay(1000);
-       
+
        cdr=bfadcan_read_register(chip->chip_base_addr+SJACDR);
        bfadcan_write_register(cdr|sjaCDR_PELICAN, chip->chip_base_addr+SJACDR);
 
@@ -126,7 +145,7 @@ int bfadcan_reset(struct candevice_t *candev)
        bfadcan_write_register(cdr|sjaCDR_PELICAN, chip->chip_base_addr+SJACDR);
 
        bfadcan_write_register(0, chip->chip_base_addr+SJAIER);
-       
+
        return 0;
 }
 
@@ -148,7 +167,7 @@ int bfadcan_reset(struct candevice_t *candev)
  * Return Value: The function always returns zero
  * File: src/bfadcan.c
  */
-int bfadcan_init_hw_data(struct candevice_t *candev) 
+int bfadcan_init_hw_data(struct candevice_t *candev)
 {
        candev->res_addr=RESET_ADDR;
        candev->nr_82527_chips=NR_82527;
@@ -182,7 +201,7 @@ int bfadcan_init_hw_data(struct candevice_t *candev)
  * The entry @int_clk_reg holds hardware specific options for the Clock Out
  * register. Options defined in the %i82527.h file:
  * %iCLK_CD0, %iCLK_CD1, %iCLK_CD2, %iCLK_CD3, %iCLK_SL0, %iCLK_SL1.
- * The entry @int_bus_reg holds hardware specific options for the Bus 
+ * The entry @int_bus_reg holds hardware specific options for the Bus
  * Configuration register. Options defined in the %i82527.h file:
  * %iBUS_DR0, %iBUS_DR1, %iBUS_DT1, %iBUS_POL, %iBUS_CBY.
  * The entry @int_cpu_reg holds hardware specific options for the cpu interface
@@ -222,7 +241,7 @@ int bfadcan_init_chip_data(struct candevice_t *candev, int chipnr)
  * CAN chip. In case of the sja1000 there's only one message object but on the
  * i82527 chip there are 15.
  * The code below is for a i82527 chip and initializes the object base addresses
- * The entry @obj_base_addr represents the first memory address of the message 
+ * The entry @obj_base_addr represents the first memory address of the message
  * object. In case of the sja1000 @obj_base_addr is taken the same as the chips
  * base address.
  * Unless the hardware uses a segmented memory map, flags can be set zero.
@@ -232,7 +251,7 @@ int bfadcan_init_chip_data(struct candevice_t *candev, int chipnr)
 int bfadcan_init_obj_data(struct canchip_t *chip, int objnr)
 {
        chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr+(objnr+1)*0x10;
-       
+
        return 0;
 }
 
@@ -240,10 +259,10 @@ int bfadcan_init_obj_data(struct canchip_t *chip, int objnr)
  * bfadcan_program_irq - program interrupts
  * @candev: Pointer to candevice/board structure
  *
- * The function bfadcan_program_irq() is used for hardware that uses 
+ * The function bfadcan_program_irq() is used for hardware that uses
  * programmable interrupts. If your hardware doesn't use programmable interrupts
- * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and 
- * leave this function unedited. Again this function is hardware specific so 
+ * you should not set the @candevices_t->flags entry to %CANDEV_PROGRAMMABLE_IRQ and
+ * leave this function unedited. Again this function is hardware specific so
  * there's no example code.
  * Return value: The function returns zero on success or %-ENODEV on failure
  * File: src/bfadcan.c