X-Git-Url: http://rtime.felk.cvut.cz/gitweb/lincan.git/blobdiff_plain/4cf24de229090b1ab6279570a564d224e13dd706..04ac67cc3cac14cd601daacd0592121ec0b84012:/lincan/src/template.c diff --git a/lincan/src/template.c b/lincan/src/template.c index 1c638ae..6708d5b 100644 --- a/lincan/src/template.c +++ b/lincan/src/template.c @@ -1,29 +1,44 @@ -/* template.c - * Linux CAN-bus device driver. - * Written by Arnaud Westenberg email:arnaud@wanadoo.nl - * This software is released under the GPL-License. - * Version 0.7 6 Aug 2001 - */ +/**************************************************************************/ +/* File: template.c - template file for writing new board support */ +/* */ +/* LinCAN - (Not only) Linux CAN bus driver */ +/* Copyright (C) 2002-2009 DCE FEE CTU Prague */ +/* Copyright (C) 2002-2009 Pavel Pisa */ +/* Funded by OCERA and FRESCOR IST projects */ +/* Based on CAN driver code by Arnaud Westenberg */ +/* */ +/* 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. */ +/**************************************************************************/ /* This file is intended as a template 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=template. */ -#include -#if defined (CONFIG_MODVERSIONS) && !defined (MODVERSIONS) -#define MODVERSIONS -#endif - -#if defined (MODVERSIONS) -#include -#endif - -#include -#include -#include -#include - +#include "../include/can.h" +#include "../include/can_sysdep.h" #include "../include/main.h" #include "../include/template.h" #include "../include/i82527.h" @@ -37,35 +52,33 @@ #define IO_RANGE 0x100 /** - * template_request_io: - reserve io memory - * @io_addr: The reserved memory starts at @io_addr, wich is the module - * parameter @io. + * template_request_io: - reserve io or memory range for can board + * @candev: pointer to candevice/board which asks for io. Field @io_addr + * of @candev is used in most cases to define start of the range * * The function template_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. * Return Value: The function returns zero on success or %-ENODEV on failure * File: src/template.c */ -int template_request_io(unsigned long io_addr) +int template_request_io(struct candevice_t *candev) { - if (check_region(io_addr,IO_RANGE)) { - CANMSG("Unable to open port: 0x%lx\n",io_addr); + if (!can_request_io_region(candev->io_addr,IO_RANGE,DEVICE_NAME)) { + CANMSG("Unable to open port: 0x%lx\n",candev->io_addr); return -ENODEV; - } - else { - request_region(io_addr,IO_RANGE,DEVICE_NAME); - DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", io_addr, io_addr + IO_RANGE - 1); + }else { + DEBUGMSG("Registered IO-memory: 0x%lx - 0x%lx\n", candev->io_addr, candev->io_addr + IO_RANGE - 1); } return 0; } /** - * template_release_io - free reserved io-memory - * @io_addr: Start of the memory range to be released. + * template_release_io - free reserved io memory range + * @candev: pointer to candevice/board which releases io * * The function template_release_io() is used to free reserved io-memory. * In case you have reserved more io memory, don't forget to free it here. @@ -75,60 +88,60 @@ int template_request_io(unsigned long io_addr) * Return Value: The function always returns zero * File: src/template.c */ -int template_release_io(unsigned long io_addr) +int template_release_io(struct candevice_t *candev) { - release_region(io_addr,IO_RANGE); + can_release_io_region(candev->io_addr,IO_RANGE); return 0; } /** * template_reset - hardware reset routine - * @card: Number of the hardware card. + * @candev: Pointer to candevice/board structure * - * The function template_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 template_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/template.c */ -int template_reset(int card) +int template_reset(struct candevice_t *candev) { return 0; } #define RESET_ADDR 0x0 -#define NR_82527 0 +#define NR_82527 1 #define NR_SJA1000 0 /** - * template_init_hw_data - Initialze hardware cards - * @card: Number of the hardware card. + * template_init_hw_data - Initialize hardware cards + * @candev: Pointer to candevice/board structure * * The function template_init_hw_data() is used to initialize the hardware * structure containing information about the installed CAN-board. * %RESET_ADDR represents the io-address of the hardware reset register. - * %NR_82527 represents the number of intel 82527 chips on the board. - * %NR_SJA1000 represents the number of philips sja1000 chips on the board. - * The flags entry can currently only be %PROGRAMMABLE_IRQ to indicate that + * %NR_82527 represents the number of Intel 82527 chips on the board. + * %NR_SJA1000 represents the number of Philips sja1000 chips on the board. + * The flags entry can currently only be %CANDEV_PROGRAMMABLE_IRQ to indicate that * the hardware uses programmable interrupts. * Return Value: The function always returns zero * File: src/template.c */ -int template_init_hw_data(int card) +int template_init_hw_data(struct candevice_t *candev) { - candevices_p[card]->res_addr=RESET_ADDR; - candevices_p[card]->nr_82527_chips=1; - candevices_p[card]->nr_sja1000_chips=0; - candevices_p[card]->flags |= PROGRAMMABLE_IRQ; + candev->res_addr=RESET_ADDR; + candev->nr_82527_chips=NR_82527; + candev->nr_sja1000_chips=NR_SJA1000; + candev->nr_all_chips=NR_82527+NR_SJA1000; + candev->flags |= CANDEV_PROGRAMMABLE_IRQ; return 0; } -#define CHIP_TYPE "i82527" /** * template_init_chip_data - Initialize chips - * @card: Number of the hardware card + * @candev: Pointer to candevice/board structure * @chipnr: Number of the CAN chip on the hardware card * * The function template_init_chip_data() is used to initialize the hardware @@ -141,15 +154,15 @@ int template_init_hw_data(int card) * The @clock entry holds the chip clock value in Hz. * The entry @sja_cdr_reg holds hardware specific options for the Clock Divider * register. Options defined in the %sja1000.h file: - * %CDR_CLKOUT_MASK, %CDR_CLK_OFF, %CDR_RXINPEN, %CDR_CBP, %CDR_PELICAN + * %sjaCDR_CLKOUT_MASK, %sjaCDR_CLK_OFF, %sjaCDR_RXINPEN, %sjaCDR_CBP, %sjaCDR_PELICAN * The entry @sja_ocr_reg holds hardware specific options for the Output Control * register. Options defined in the %sja1000.h file: - * %OCR_MODE_BIPHASE, %OCR_MODE_TEST, %OCR_MODE_NORMAL, %OCR_MODE_CLOCK, - * %OCR_TX0_LH, %OCR_TX1_ZZ. + * %sjaOCR_MODE_BIPHASE, %sjaOCR_MODE_TEST, %sjaOCR_MODE_NORMAL, %sjaOCR_MODE_CLOCK, + * %sjaOCR_TX0_LH, %sjaOCR_TX1_ZZ. * 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 @@ -158,24 +171,27 @@ int template_init_hw_data(int card) * Return Value: The function always returns zero * File: src/template.c */ -int template_init_chip_data(int card, int chipnr) +int template_init_chip_data(struct candevice_t *candev, int chipnr) { - candevices_p[card]->chip[chipnr]->chip_type=CHIP_TYPE; - candevices_p[card]->chip[chipnr]->chip_base_addr=candevices_p[card]->io_addr; - candevices_p[card]->chip[chipnr]->clock = 16000000; - candevices_p[card]->chip[chipnr]->int_cpu_reg = iCPU_DSC; - candevices_p[card]->chip[chipnr]->int_clk_reg = iCLK_SL1; - candevices_p[card]->chip[chipnr]->int_bus_reg = iBUS_CBY; - candevices_p[card]->chip[chipnr]->sja_cdr_reg = CDR_CBP | CDR_CLK_OFF; - candevices_p[card]->chip[chipnr]->sja_ocr_reg = OCR_MODE_NORMAL | - OCR_TX0_LH; + i82527_fill_chipspecops(candev->chip[chipnr]); + /*sja1000_fill_chipspecops(candev->chip[chipnr]);*/ + /*sja1000p_fill_chipspecops(candev->chip[chipnr]);*/ + + candev->chip[chipnr]->chip_base_addr=can_ioport2ioptr(candev->io_addr); + candev->chip[chipnr]->clock = 16000000; + candev->chip[chipnr]->int_cpu_reg = iCPU_DSC; + candev->chip[chipnr]->int_clk_reg = iCLK_SL1; + candev->chip[chipnr]->int_bus_reg = iBUS_CBY; + candev->chip[chipnr]->sja_cdr_reg = sjaCDR_CBP | sjaCDR_CLK_OFF; + candev->chip[chipnr]->sja_ocr_reg = sjaOCR_MODE_NORMAL | + sjaOCR_TX0_LH; return 0; } /** * template_init_obj_data - Initialize message buffers - * @chipnr: Number of the CAN chip + * @chip: Pointer to chip specific structure * @objnr: Number of the message buffer * * The function template_init_obj_data() is used to initialize the hardware @@ -183,34 +199,33 @@ int template_init_chip_data(int card, 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. * Return Value: The function always returns zero * File: src/template.c */ -int template_init_obj_data(int chipnr, int objnr) +int template_init_obj_data(struct canchip_t *chip, int objnr) { - chips_p[chipnr]->msgobj[objnr]->obj_base_addr=chips_p[chipnr]->chip_base_addr+(objnr+1)*0x10; - chips_p[chipnr]->msgobj[objnr]->flags=0; - + chip->msgobj[objnr]->obj_base_addr=chip->chip_base_addr+(objnr+1)*0x10; + return 0; } /** * template_program_irq - program interrupts - * @card: Number of the hardware card. + * @candev: Pointer to candevice/board structure * - * The function template_program_irq() is used for hardware that uses + * The function template_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 %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/template.c */ -int template_program_irq(int card) +int template_program_irq(struct candevice_t *candev) { return 0; } @@ -226,9 +241,9 @@ int template_program_irq(int card) * Return Value: The function does not return a value * File: src/template.c */ -void template_write_register(unsigned char data, unsigned long address) +void template_write_register(unsigned data, can_ioptr_t address) { - outb(data,address); + can_outb(data,address); } /** @@ -241,9 +256,9 @@ void template_write_register(unsigned char data, unsigned long address) * Return Value: The function returns the value stored in @address * File: src/template.c */ -unsigned template_read_register(unsigned long address) +unsigned template_read_register(can_ioptr_t address) { - return inb(address); + return can_inb(address); } /* !!! Don't change this function !!! */