]> rtime.felk.cvut.cz Git - lincan.git/blobdiff - lincan/src/virtual.c
LinCAN sources go through big white-space cleanup.
[lincan.git] / lincan / src / virtual.c
index 80ce0fbd5f07df20f61c442eaf63e97e545bfd48..eb8043f82c24af44ef1b17c2c16bf2a0e8ff104a 100644 (file)
@@ -1,11 +1,36 @@
-/* virtual.c
- * Linux CAN-bus device driver.
- * Written for new CAN driver version by Pavel Pisa - OCERA team member
- * email:pisa@cmp.felk.cvut.cz
- * This software is released under the GPL-License.
- * Version lincan-0.2  9 Jul 2003
- */ 
-
+/**************************************************************************/
+/* File: virtual.c - virtual chip/board support                           */
+/*                                                                        */
+/* 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.  */
+/**************************************************************************/
 #include "../include/can.h"
 #include "../include/can_sysdep.h"
 #include "../include/main.h"
@@ -24,12 +49,12 @@ long virtual_bus_latency(struct msgobj_t *obj)
 
 /* * * Virtual Chip Functionality * * */
 
-int virtual_enable_configuration(struct chip_t *chip)
+int virtual_enable_configuration(struct canchip_t *chip)
 {
        return 0;
 }
 
-int virtual_disable_configuration(struct chip_t *chip)
+int virtual_disable_configuration(struct canchip_t *chip)
 {
        return 0;
 }
@@ -41,7 +66,7 @@ int virtual_disable_configuration(struct chip_t *chip)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_chip_config(struct chip_t *chip)
+int virtual_chip_config(struct canchip_t *chip)
 {
        return 0;
 }
@@ -55,7 +80,7 @@ int virtual_chip_config(struct chip_t *chip)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_extended_mask(struct chip_t *chip, unsigned long code, unsigned  long mask)
+int virtual_extended_mask(struct canchip_t *chip, unsigned long code, unsigned  long mask)
 {
        return 0;
 }
@@ -72,7 +97,7 @@ int virtual_extended_mask(struct chip_t *chip, unsigned long code, unsigned  lon
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_baud_rate(struct chip_t *chip, int rate, int clock, int sjw,
+int virtual_baud_rate(struct canchip_t *chip, int rate, int clock, int sjw,
                                                        int sampl_pt, int flags)
 {
        return 0;
@@ -85,7 +110,7 @@ int virtual_baud_rate(struct chip_t *chip, int rate, int clock, int sjw,
  *
  * File: src/virtual.c
  */
-void virtual_read(struct chip_t *chip, struct msgobj_t *obj) {
+void virtual_read(struct canchip_t *chip, struct msgobj_t *obj) {
 
 }
 
@@ -98,7 +123,7 @@ void virtual_read(struct chip_t *chip, struct msgobj_t *obj) {
  *     Positive value indicates immediate reception of message.
  * File: src/virtual.c
  */
-int virtual_pre_read_config(struct chip_t *chip, struct msgobj_t *obj)
+int virtual_pre_read_config(struct canchip_t *chip, struct msgobj_t *obj)
 {
        return 0;
 }
@@ -113,7 +138,7 @@ int virtual_pre_read_config(struct chip_t *chip, struct msgobj_t *obj)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_pre_write_config(struct chip_t *chip, struct msgobj_t *obj, 
+int virtual_pre_write_config(struct canchip_t *chip, struct msgobj_t *obj,
                                                        struct canmsg_t *msg)
 {
        return 0;
@@ -130,7 +155,7 @@ int virtual_pre_write_config(struct chip_t *chip, struct msgobj_t *obj,
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_send_msg(struct chip_t *chip, struct msgobj_t *obj, 
+int virtual_send_msg(struct canchip_t *chip, struct msgobj_t *obj,
                                                        struct canmsg_t *msg)
 {
        return 0;
@@ -145,7 +170,7 @@ int virtual_send_msg(struct chip_t *chip, struct msgobj_t *obj,
  *     Zero value indicates finishing of all issued transmission requests.
  * File: src/virtual.c
  */
-int virtual_check_tx_stat(struct chip_t *chip)
+int virtual_check_tx_stat(struct canchip_t *chip)
 {
        return 0;
 }
@@ -159,7 +184,7 @@ int virtual_check_tx_stat(struct chip_t *chip)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_set_btregs(struct chip_t *chip, unsigned short btr0, 
+int virtual_set_btregs(struct canchip_t *chip, unsigned short btr0,
                                                        unsigned short btr1)
 {
        return 0;
@@ -172,7 +197,7 @@ int virtual_set_btregs(struct chip_t *chip, unsigned short btr0,
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_start_chip(struct chip_t *chip)
+int virtual_start_chip(struct canchip_t *chip)
 {
        return 0;
 }
@@ -184,11 +209,35 @@ int virtual_start_chip(struct chip_t *chip)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_stop_chip(struct chip_t *chip)
+int virtual_stop_chip(struct canchip_t *chip)
 {
        return 0;
 }
 
+/**
+ * virtual_attach_to_chip: - attaches to the chip, setups registers and state
+ * @chip: pointer to chip state structure
+ *
+ * Return Value: negative value reports error.
+ * File: src/virtual.c
+ */
+int virtual_attach_to_chip(struct canchip_t *chip)
+{
+       return 0;
+}
+
+/**
+ * virtual_release_chip: - called before chip structure removal if %CHIP_ATTACHED is set
+ * @chip: pointer to chip state structure
+ *
+ * Return Value: negative value reports error.
+ * File: src/virtual.c
+ */
+int virtual_release_chip(struct canchip_t *chip)
+{
+       virtual_stop_chip(chip);
+       return 0;
+}
 
 /**
  * virtual_remote_request: - configures message object and asks for RTR message
@@ -198,7 +247,7 @@ int virtual_stop_chip(struct chip_t *chip)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_remote_request(struct chip_t *chip, struct msgobj_t *obj)
+int virtual_remote_request(struct canchip_t *chip, struct msgobj_t *obj)
 {
        CANMSG("virtual_remote_request not implemented\n");
        return -ENOSYS;
@@ -213,7 +262,7 @@ int virtual_remote_request(struct chip_t *chip, struct msgobj_t *obj)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_standard_mask(struct chip_t *chip, unsigned short code,
+int virtual_standard_mask(struct canchip_t *chip, unsigned short code,
                unsigned short mask)
 {
        CANMSG("virtual_standard_mask not implemented\n");
@@ -227,7 +276,7 @@ int virtual_standard_mask(struct chip_t *chip, unsigned short code,
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_clear_objects(struct chip_t *chip)
+int virtual_clear_objects(struct canchip_t *chip)
 {
        CANMSG("virtual_clear_objects not implemented\n");
        return -ENOSYS;
@@ -241,7 +290,7 @@ int virtual_clear_objects(struct chip_t *chip)
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_config_irqs(struct chip_t *chip, short irqs)
+int virtual_config_irqs(struct canchip_t *chip, short irqs)
 {
        CANMSG("virtual_config_irqs not implemented\n");
        return -ENOSYS;
@@ -258,7 +307,7 @@ int virtual_config_irqs(struct chip_t *chip, short irqs)
  * virtual_irq_write_handler() for transmit events.
  * File: src/virtual.c
  */
-void virtual_irq_write_handler(struct chip_t *chip, struct msgobj_t *obj)
+void virtual_irq_write_handler(struct canchip_t *chip, struct msgobj_t *obj)
 {
 
 }
@@ -270,9 +319,9 @@ void virtual_irq_write_handler(struct chip_t *chip, struct msgobj_t *obj)
  * @irq: interrupt vector number, this value is system specific
  * @dev_id: driver private pointer registered at time of request_irq() call.
  *     The CAN driver uses this pointer to store relationship of interrupt
- *     to chip state structure - @struct chip_t
+ *     to chip state structure - @struct canchip_t
  * @regs: system dependent value pointing to registers stored in exception frame
- * 
+ *
  * Interrupt handler is activated when state of CAN controller chip changes,
  * there is message to be read or there is more space for new messages or
  * error occurs. The receive events results in reading of the message from
@@ -280,9 +329,9 @@ void virtual_irq_write_handler(struct chip_t *chip, struct msgobj_t *obj)
  * message queues.
  * File: src/virtual.c
  */
-can_irqreturn_t virtual_irq_handler(int irq, void *dev_id, struct pt_regs *regs)
+int virtual_irq_handler(int irq, struct canchip_t *chip)
 {
-       return CAN_IRQ_HANDLED;
+       return CANCHIP_IRQ_HANDLED;
 }
 
 
@@ -293,20 +342,20 @@ void virtual_schedule_next(struct msgobj_t *obj)
        can_preempt_disable();
 
        can_msgobj_set_fl(obj,TX_REQUEST);
-       
+
        while(!can_msgobj_test_and_set_fl(obj,TX_LOCK)){
 
                can_msgobj_clear_fl(obj,TX_REQUEST);
-               
+
                cmd=canque_test_outslot(obj->qends, &obj->tx_qedge, &obj->tx_slot);
                if(cmd>=0) {
                        mod_timer(&obj->tx_timeout,
                                jiffies+virtual_bus_latency(obj));
-                       CANMSG("virtual: scheduled delivery\n");
+                       DEBUGMSG("virtual: scheduled delivery\n");
 
-               } else          
+               } else
                        can_msgobj_clear_fl(obj,TX_LOCK);
-               
+
                if(!can_msgobj_test_fl(obj,TX_REQUEST)) break;
                DEBUGMSG("TX looping in virtual_schedule_next\n");
        }
@@ -318,14 +367,17 @@ void virtual_schedule_next(struct msgobj_t *obj)
 void virtual_do_tx_timeout(unsigned long data)
 {
        struct msgobj_t *obj=(struct msgobj_t *)data;
-       
+
        if(obj->tx_slot) {
+               /* fill CAN message timestamp */
+               can_filltimestamp(&obj->tx_slot->msg.timestamp);
+
                /* Deliver message to edges */
                canque_filter_msg2edges(obj->qends, &obj->tx_slot->msg);
                /* Free transmitted slot */
                canque_free_outslot(obj->qends, obj->tx_qedge, obj->tx_slot);
                obj->tx_slot=NULL;
-               CANMSG("virtual: delayed delivery\n");
+               DEBUGMSG("virtual: delayed delivery\n");
        }
        can_msgobj_clear_fl(obj,TX_LOCK);
 
@@ -337,25 +389,33 @@ void virtual_do_tx_timeout(unsigned long data)
  * @chip: pointer to chip state structure
  * @obj: pointer to message object structure
  *
+ * Function is responsible for initiating message transmition.
+ * It is responsible for clearing of object TX_REQUEST flag
+ *
  * Return Value: negative value reports error.
  * File: src/virtual.c
  */
-int virtual_wakeup_tx(struct chip_t *chip, struct msgobj_t *obj)
+int virtual_wakeup_tx(struct canchip_t *chip, struct msgobj_t *obj)
 {
        /* can_msgobj_set_fl(obj,TX_REQUEST); */
-       
+
        struct canque_edge_t *qedge;
        struct canque_slot_t *slot;
        int cmd;
 
+       can_msgobj_clear_fl(obj,TX_REQUEST);
+
     #ifndef CAN_WITH_RTL
        if(!virtual_bus_latency(obj)) {
     #endif /*CAN_WITH_RTL*/
                /* Ensure delivery of all ready slots */
                while((cmd=canque_test_outslot(obj->qends, &qedge, &slot)) >= 0){
                        if(cmd==0) {
+                               /* fill CAN message timestamp */
+                               can_filltimestamp(&slot->msg.timestamp);
+
                                canque_filter_msg2edges(obj->qends, &slot->msg);
-                               CANMSG("virtual: direct delivery\n");
+                               DEBUGMSG("virtual: direct delivery\n");
                        }
                        canque_free_outslot(obj->qends, qedge, slot);
                }
@@ -415,7 +475,7 @@ int virtual_reset(struct candevice_t *candev)
  * Return Value: The function always returns zero
  * File: src/virtual.c
  */
-int virtual_init_hw_data(struct candevice_t *candev) 
+int virtual_init_hw_data(struct candevice_t *candev)
 {
        candev->res_addr=0;
        candev->nr_82527_chips=0;
@@ -438,7 +498,7 @@ int virtual_init_hw_data(struct candevice_t *candev)
  */
 int virtual_init_chip_data(struct candevice_t *candev, int chipnr)
 {
-       struct chip_t *chip = candev->chip[chipnr];
+       struct canchip_t *chip = candev->chip[chipnr];
        chip->chip_type = CHIP_TYPE;
        chip->chip_base_addr = 0;
        chip->clock = 10000000;
@@ -462,10 +522,13 @@ int virtual_init_chip_data(struct candevice_t *candev, int chipnr)
        chip->chipspecops->remote_request=virtual_remote_request;
        chip->chipspecops->enable_configuration=virtual_enable_configuration;
        chip->chipspecops->disable_configuration=virtual_disable_configuration;
+       chip->chipspecops->attach_to_chip=virtual_attach_to_chip;
+       chip->chipspecops->release_chip=virtual_release_chip;
        chip->chipspecops->set_btregs=virtual_set_btregs;
        chip->chipspecops->start_chip=virtual_start_chip;
        chip->chipspecops->stop_chip=virtual_stop_chip;
        chip->chipspecops->irq_handler=NULL;
+       chip->chipspecops->irq_accept=NULL;
 
        return 0;
 }
@@ -478,7 +541,7 @@ int virtual_init_chip_data(struct candevice_t *candev, int chipnr)
  * Return Value: The function always returns zero
  * File: src/virtual.c
  */
-int virtual_init_obj_data(struct chip_t *chip, int objnr)
+int virtual_init_obj_data(struct canchip_t *chip, int objnr)
 {
        struct msgobj_t *obj=chip->msgobj[objnr];
        obj->obj_base_addr=chip->chip_base_addr;