]> rtime.felk.cvut.cz Git - lincan.git/blobdiff - lincan/src/setup.c
Introduced basic support for registration of "can" class and call devices,
[lincan.git] / lincan / src / setup.c
index 72ef1a9f2b2e51faf1ec284978a2dabb6d65cb31..ac8378922880c0b9af287be4693ef4fa04accc1c 100644 (file)
@@ -4,7 +4,7 @@
  * 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.2  9 Jul 2003
+ * Version lincan-0.3  17 Jun 2004
  */ 
 
 #include "../include/can.h"
 #include "../include/setup.h"
 #include "../include/finish.h"
 
-extern int sja1000_register(struct chipspecops_t *chipspecops);
-extern int sja1000p_register(struct chipspecops_t *chipspecops);
-extern int i82527_register(struct chipspecops_t *chipspecops);
-
 int init_hwspecops(struct candevice_t *candev, int *irqnum_p);
 int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p);
 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate);
-int init_obj_struct(struct candevice_t *candev, struct chip_t *hostchip, int objnr);
-int init_chipspecops(struct candevice_t *candev, int chipnr);
-
-void *can_checked_malloc(size_t size)
-{
-       struct mem_addr *mem_new;
-       void *address_p;
-       
-       address_p=kmalloc(size,GFP_KERNEL);
-       if(address_p == NULL) {
-               CANMSG("can_checked_malloc: out of the memory\n");
-               return NULL;
-       }
-
-#ifdef DEBUG_MEM
-       DEBUGMSG("can_checked_malloc: allocated %d bytes at %p, mem_head=%p\n",
-                       (int)size, address_p, mem_head);
-#endif
-
-       mem_new=(struct mem_addr *)kmalloc(sizeof(struct mem_addr),GFP_KERNEL);
-       if (mem_new == NULL) {
-               CANMSG("can_checked_malloc: memory list allocation error.\n");
-               kfree(address_p);
-               return NULL;
-       }
-       mem_new->next=mem_head;
-       mem_new->address=address_p;
-       mem_new->size=size;
-       mem_head=mem_new;
-
-       return address_p;
-}
-
-int can_checked_free(void *address_p)
-{
-       struct mem_addr **mem_pptr;
-       struct mem_addr *mem_del=NULL;
-
-#ifdef DEBUG_MEM
-       DEBUGMSG("can_checked_free %p, mem_head=%p\n", address_p, mem_head);
-#endif
-
-       for(mem_pptr = &mem_head; (mem_del = *mem_pptr); mem_pptr = &mem_del->next) {
-               if (mem_del->address != address_p)
-                       continue;
-               *mem_pptr=mem_del->next;
-               kfree(mem_del);
-               kfree(address_p);
-               return 0;
-       }
-       
-       CANMSG("can_checked_free: address %p not found on the mem list\n", address_p);
-       
-       kfree(address_p);
-       return -1;
-}
-
-
-int can_del_mem_list(void)
-{
-       struct mem_addr *mem;
-
-#ifdef DEBUG_MEM
-       DEBUGMSG("can_del_mem_list, mem_head=%p\n", mem_head);
-#endif
-       if(mem_head == NULL) {
-               CANMSG("can_del_mem_list: no entries on the list - OK\n");
-               return 0;
-       }
-
-       while((mem=mem_head) != NULL) {
-               mem_head=mem->next;
-               CANMSG("can_del_mem_list: deleting %p with size %d\n",
-                       mem->address, (int)mem->size);
-               kfree(mem->address);
-               kfree(mem);
-       }
-       
-       return 0;
-}
-
-int can_request_io_region(unsigned long start, unsigned long n, const char *name)
-{
-    #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,0))
-       if(check_region(start,n)) return 0;
-       request_region(start,n,name);
-       return 1;
-    #else
-       return (request_region(start,n,name))?1:0;
-    #endif
-}
-
-void can_release_io_region(unsigned long start, unsigned long n)
-{
-       release_region(start,n);
-}
-
-int can_request_mem_region(unsigned long start, unsigned long n, const char *name)
-{
-    #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,0))
-       return 1;
-    #else
-       return (request_mem_region(start,n,name))?1:0;
-    #endif
-}
-
-void can_release_mem_region(unsigned long start, unsigned long n)
-{
-    #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,0))
-       return;
-    #else
-       release_mem_region(start,n);
-    #endif
-}
-
-/* This function shifts all base address structures acording to address
-   translation between physical and virtual address mappings */
+int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr);
+
+/**
+ * can_base_addr_fixup - relocates board physical memory addresses to the CPU accessible ones
+ * @candev: pointer to the previously filled device/board, chips and message objects structures
+ * @new_base: @candev new base address
+ *
+ * This function adapts base addresses of all structures of one board
+ * to the new board base address.
+ * It is required for translation between physical and virtual address mappings.
+ * This function is prepared to simplify board specific xxx_request_io() function
+ * for memory mapped devices.
+ */
 int can_base_addr_fixup(struct candevice_t *candev, unsigned long new_base)
 {
        unsigned long offs;
@@ -153,7 +45,37 @@ int can_base_addr_fixup(struct candevice_t *candev, unsigned long new_base)
        return 0;
 }
 
+/**
+ * can_check_dev_taken - checks if bus device description is already taken by driver
+ * @anydev:    pointer to bus specific Linux device description 
+ *
+ * Returns: Returns 1 if device is already used by LinCAN driver, 0 otherwise.
+ */
+int can_check_dev_taken(void *anydev)
+{
+       int board_nr;
+       struct candevice_t *candev;
+       void *boarddev;
+
+       for (board_nr=hardware_p->nr_boards; board_nr--; ) {
+               if((candev=hardware_p->candevice[board_nr])==NULL)
+                       continue;
+               boarddev=candev->sysdevptr.anydev;
+               if(boarddev == anydev)
+                       return 1;
+       }
+       
+       return 0;
+}
+
 
+/**
+ * register_obj_struct - registers message object into global array
+ * @obj: the initialized message object being registered
+ * @minorbase: wanted minor number, if (-1) automatically selected
+ *
+ * Return Value: returns negative number in the case of fail
+ */
 int register_obj_struct(struct msgobj_t *obj, int minorbase)
 {
        static int next_minor=0;
@@ -178,7 +100,14 @@ int register_obj_struct(struct msgobj_t *obj, int minorbase)
 }
 
 
-int register_chip_struct(struct chip_t *chip, int minorbase)
+/**
+ * register_chip_struct - registers chip into global array
+ * @chip: the initialized chip structure being registered
+ * @minorbase: wanted minor number base, if (-1) automatically selected
+ *
+ * Return Value: returns negative number in the case of fail
+ */
+int register_chip_struct(struct canchip_t *chip, int minorbase)
 {
        static int next_chip_slot=0;
        int i;
@@ -199,7 +128,14 @@ int register_chip_struct(struct chip_t *chip, int minorbase)
 }
 
 
-/* The function init_hw_struct is used to initialize the hardware structure. */
+
+/**
+ * init_hw_struct - initializes driver hardware description structures
+ *
+ * The function init_hw_struct() is used to initialize the hardware structure.
+ *
+ * Return Value: returns negative number in the case of fail
+ */
 int init_hw_struct(void)
 {
        int i=0;
@@ -220,8 +156,28 @@ int init_hw_struct(void)
        return 0;
 }
 
-/* The function init_device_struct is used to initialize a single device 
- * structure.
+/**
+ * init_device_struct - initializes single CAN device/board
+ * @card: index into @hardware_p HW description
+ * @chan_param_idx_p: pointer to the index into arrays of the CAN channel parameters
+ * @irq_param_idx_p: pointer to the index into arrays of the per CAN channel IRQ parameters
+ *
+ * The function builds representation of the one board from parameters provided
+ * in the module parameters arrays: 
+ *     @hw[card] .. hardware type,
+ *     @io[card] .. base IO address,
+ *     @baudrate[chan_param_idx] .. per channel baudrate,
+ *     @minor[chan_param_idx] .. optional specification of requested channel minor base,
+ *     @irq[irq_param_idx] .. one or more board/chips IRQ parameters.
+ * The indexes are advanced after consumed parameters if the registration is successful.
+ *
+ * The hardware specific operations of the device/board are initialized by call to
+ * init_hwspecops() function. Then board data are initialized by board specific 
+ * init_hw_data() function. Then chips and objects representation is build by
+ * init_chip_struct() function. If all above steps are successful, chips and
+ * message objects are registered into global arrays. 
+ *
+ * Return Value: returns negative number in the case of fail
  */
 int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p)
 {
@@ -276,7 +232,7 @@ int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p)
 
        for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
                int m=minor[*chan_param_idx_p+chipnr];
-               struct chip_t *chip=candev->chip[chipnr];
+               struct canchip_t *chip=candev->chip[chipnr];
                int objnr;
 
                register_chip_struct(chip, m);
@@ -308,20 +264,31 @@ int init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p)
        
 }
 
-/* The function init_chip_struct is used to initialize all chip_t structures
- * on one hardware board.
+/**
+ * init_chip_struct - initializes one CAN chip structure
+ * @candev: pointer to the corresponding CAN device/board
+ * @chipnr: index of the chip in the corresponding device/board structure
+ * @irq: chip IRQ number or (-1) if not appropriate
+ * @baudrate: baudrate in the units of 1Bd
+ *
+ * Chip structure is allocated and chip specific operations are filled by 
+ * call to board specific init_chip_data() which calls chip specific
+ * fill_chipspecops(). The message objects are generated by 
+ * calls to init_obj_struct() function.
+ *
+ * Return Value: returns negative number in the case of fail
  */
 int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate)
 {
-       struct chip_t *chip;
+       struct canchip_t *chip;
        int objnr;
        int ret;
 
-       candev->chip[chipnr]=(struct chip_t *)can_checked_malloc(sizeof(struct chip_t));
+       candev->chip[chipnr]=(struct canchip_t *)can_checked_malloc(sizeof(struct canchip_t));
        if ((chip=candev->chip[chipnr])==NULL)
                return -ENOMEM;
 
-        memset(chip, 0, sizeof(struct chip_t));
+        memset(chip, 0, sizeof(struct canchip_t));
 
        chip->write_register=candev->hwspecops->write_register;
        chip->read_register=candev->hwspecops->read_register;
@@ -329,6 +296,7 @@ int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudr
        chip->chipspecops=can_checked_malloc(sizeof(struct chipspecops_t));
        if (chip->chipspecops==NULL)
                return -ENOMEM;
+       memset(chip->chipspecops,0,sizeof(struct chipspecops_t));
 
        chip->chip_idx=chipnr;
        chip->hostdevice=candev;
@@ -336,9 +304,7 @@ int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudr
        chip->baudrate=baudrate;
        chip->flags=0x0;
 
-       candev->hwspecops->init_chip_data(candev,chipnr);
-
-       if (init_chipspecops(candev,chipnr))
+       if(candev->hwspecops->init_chip_data(candev,chipnr)<0)
                return -ENODEV;
 
        for (objnr=0; objnr<chip->max_objects; objnr++) {
@@ -350,7 +316,18 @@ int init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudr
 }
 
 
-int init_obj_struct(struct candevice_t *candev, struct chip_t *hostchip, int objnr)
+/**
+ * init_obj_struct - initializes one CAN message object structure
+ * @candev: pointer to the corresponding CAN device/board
+ * @hostchip: pointer to the chip containing this object
+ * @objnr: index of the builded object in the chip structure
+ *
+ * The function initializes message object structure and allocates and initializes
+ * CAN queue chip ends structure.
+ *
+ * Return Value: returns negative number in the case of fail
+ */
+int init_obj_struct(struct candevice_t *candev, struct canchip_t *hostchip, int objnr)
 {
        struct canque_ends_t *qends;
        struct msgobj_t *obj;
@@ -388,6 +365,17 @@ int init_obj_struct(struct candevice_t *candev, struct chip_t *hostchip, int obj
 }
 
 
+/**
+ * init_hwspecops - finds and initializes board/device specific operations
+ * @candev: pointer to the corresponding CAN device/board
+ * @irqnum_p: optional pointer to the number of interrupts required by board
+ *
+ * The function searches board @hwname in the list of supported boards types.
+ * The board type specific board_register() function is used to initialize
+ * @hwspecops operations.
+ *
+ * Return Value: returns negative number in the case of fail
+ */
 int init_hwspecops(struct candevice_t *candev, int *irqnum_p)
 {
        const struct boardtype_t *brp;
@@ -405,51 +393,3 @@ int init_hwspecops(struct candevice_t *candev, int *irqnum_p)
 
        return 0;
 }
-
-
-int init_chipspecops(struct candevice_t *candev, int chipnr)
-{
-       if (!strcmp(candev->chip[chipnr]->chip_type,"i82527")) {
-               candev->chip[chipnr]->max_objects=15;
-               i82527_register(candev->chip[chipnr]->chipspecops);
-       } 
-       if (!strcmp(candev->chip[chipnr]->chip_type,"sja1000")) {
-               candev->chip[chipnr]->max_objects=1;
-               sja1000_register(candev->chip[chipnr]->chipspecops);
-       }
-       if (!strcmp(candev->chip[chipnr]->chip_type,"sja1000p")) {
-               candev->chip[chipnr]->max_objects=1;
-               sja1000p_register(candev->chip[chipnr]->chipspecops);
-       }
-
-       return 0;
-}
-
-#ifndef CAN_WITH_RTL
-
-int can_chip_setup_irq(struct chip_t *chip)
-{
-       if(chip==NULL)
-               return -1;
-       if(!chip->chipspecops->irq_handler)
-               return 0;
-                       
-       if (request_irq(chip->chip_irq,chip->chipspecops->irq_handler,SA_SHIRQ,DEVICE_NAME,chip))
-               return -1;
-       else {
-               DEBUGMSG("Registered interrupt %d\n",chip->chip_irq);
-               chip->flags |= CHIP_IRQ_SETUP;
-       }
-       return 1;
-}
-
-
-void can_chip_free_irq(struct chip_t *chip)
-{
-       if((chip->flags & CHIP_IRQ_SETUP) && (chip->chip_irq>=0)) {
-               free_irq(chip->chip_irq, chip);
-               chip->flags &= ~CHIP_IRQ_SETUP;
-       }
-}
-
-#endif /*CAN_WITH_RTL*/