Whitespace cleanup in some LinCAN source files to prepare for integration of Jan...

[lincan.git] / lincan / src / finish.c

diff --git a/lincan/src/finish.c b/lincan/src/finish.c
index 922b4d3608077fe03dfda6a78142707b7e2566b7..532d868c4b8edf93a22775299aa842b625d20f1c 100644 (file)
--- a/lincan/src/finish.c
+++ b/lincan/src/finish.c
@@ -1,3 +1,12 @@
+/* finish.c - finalization of the driver operation
+ * 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
+ */
+
 #include "../include/can.h"
 #include "../include/can_sysdep.h"
 #include "../include/main.h"
@@ -6,7 +15,10 @@
 #include "../include/setup.h"
 
 
-
+/**
+ * msgobj_done - destroys one CAN message object
+ * @obj: pointer to CAN message object structure
+ */
 void msgobj_done(struct msgobj_t *obj)
 {
        int delayed=0;
@@ -20,17 +32,17 @@ void msgobj_done(struct msgobj_t *obj)
                if(obj->hostchip->msgobj[obj->object-1] == obj)
                        obj->hostchip->msgobj[obj->object-1]=NULL;
                else
-                       CANMSG("msgobj_done: not registered in the chip_t\n");
+                       CANMSG("msgobj_done: not registered in the canchip_t\n");
                obj->hostchip=NULL;
        }
-       
+
        if((obj->minor>=0)) {
                if(objects_p[obj->minor] == obj)
                        objects_p[obj->minor] = NULL;
                else
                        CANMSG("msgobj_done: not registered as minor\n");
        }
-       
+
        del_timer_sync(&obj->tx_timeout);
 
        if(obj->qends) {
@@ -44,12 +56,19 @@ void msgobj_done(struct msgobj_t *obj)
 }
 
 
-void canchip_done(struct chip_t *chip)
+/**
+ * canchip_done - destroys one CAN chip representation
+ * @chip: pointer to CAN chip structure
+ */
+void canchip_done(struct canchip_t *chip)
 {
 
        int i;
        struct msgobj_t *obj;
 
+       if(chip->flags & CHIP_ATTACHED)
+               chip->chipspecops->release_chip(chip);
+
        if((chip->hostdevice) && (chip->chip_idx>=0)) {
                if(chip->hostdevice->chip[chip->chip_idx] == chip)
                        chip->hostdevice->chip[chip->chip_idx] = NULL;
@@ -58,32 +77,36 @@ void canchip_done(struct chip_t *chip)
        }
 
        can_chip_free_irq(chip);
-               
+
        can_synchronize_irq(chip->chip_irq);
-       
+
        for(i=0; i<chip->max_objects; i++){
                if((obj=chip->msgobj[i])==NULL)
                        continue;
                msgobj_done(obj);
                can_checked_free(obj);
        }
-       
+
        can_checked_free(chip->chipspecops);
        chip->chipspecops=NULL;
 
 }
 
+/**
+ * candevice_done - destroys representation of one CAN device/board
+ * @candev: pointer to CAN device/board structure
+ */
 void candevice_done(struct candevice_t *candev)
 {
        int i;
-       struct chip_t *chip;
-       
+       struct canchip_t *chip;
+
        for(i=0; i<candev->nr_all_chips; i++){
                if((chip=candev->chip[i])==NULL)
                        continue;
                canchip_done(chip);
                can_checked_free(chip);
-       
+
        }
        if(candev->flags & CANDEV_IO_RESERVED) {
                candev->hwspecops->release_io(candev);
@@ -93,11 +116,15 @@ void candevice_done(struct candevice_t *candev)
        candev->hwspecops=NULL;
 }
 
+/**
+ * candevice_done - destroys representation of all CAN devices/boards
+ * @canhw: pointer to the root of all CAN hardware representation
+ */
 void canhardware_done(struct canhardware_t *canhw)
 {
        int i;
        struct candevice_t *candev;
-       
+
        for(i=0; i<canhw->nr_boards; i++){
                if((candev=canhw->candevice[i])==NULL)
                        continue;