extern int sja1000p_register(struct chipspecops_t *chipspecops);
extern int i82527_register(struct chipspecops_t *chipspecops);
-int init_device_struct(int card);
-int init_hwspecops(struct candevice_t *candev);
-int init_chip_struct(struct candevice_t *candev);
-int init_obj_struct(struct candevice_t *candev, struct chip_t *hostchip, int minorbase);
+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);
+/**
+ * can_checked_malloc - memory allocation with registering of requested blocks
+ * @size: size of the requested block
+ *
+ * The function is used in the driver initialization phase to catch possible memory
+ * leaks for future driver finalization or case, that driver initialization fail.
+ *
+ * Return Value: pointer to the allocated memory or NULL in the case of fail
+ */
void *can_checked_malloc(size_t size)
{
struct mem_addr *mem_new;
return address_p;
}
+/**
+ * can_checked_free - free memory allocated by can_checked_malloc()
+ * @address_p: pointer to the memory block
+ */
int can_checked_free(void *address_p)
{
struct mem_addr **mem_pptr;
}
+/**
+ * can_del_mem_list - check for stale memory allocations at driver finalization
+ *
+ * Checks, if there are still some memory blocks allocated and releases memory
+ * occupied by such blocks back to the system
+ */
int can_del_mem_list(void)
{
struct mem_addr *mem;
return 0;
}
+/**
+ * can_request_io_region - request IO space region
+ * @start: the first IO port address
+ * @n: number of the consecutive IO port addresses
+ * @name: name/label for the requested region
+ *
+ * The function hides system specific implementation of the feature.
+ *
+ * Return Value: returns positive value (1) in the case, that region could
+ * be reserved for the driver. Returns zero (0) if there is collision with
+ * other driver or region cannot be taken for some other reason.
+ */
int can_request_io_region(unsigned long start, unsigned long n, const char *name)
{
#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,0))
#endif
}
+/**
+ * can_release_io_region - release IO space region
+ * @start: the first IO port address
+ * @n: number of the consecutive IO port addresses
+ */
void can_release_io_region(unsigned long start, unsigned long n)
{
release_region(start,n);
}
+/**
+ * can_request_mem_region - request memory space region
+ * @start: the first memory port physical address
+ * @n: number of the consecutive memory port addresses
+ * @name: name/label for the requested region
+ *
+ * The function hides system specific implementation of the feature.
+ *
+ * Return Value: returns positive value (1) in the case, that region could
+ * be reserved for the driver. Returns zero (0) if there is collision with
+ * other driver or region cannot be taken for some other reason.
+ */
int can_request_mem_region(unsigned long start, unsigned long n, const char *name)
{
#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,0))
#endif
}
+/**
+ * can_release_mem_region - release memory space region
+ * @start: the first memory port physical address
+ * @n: number of the consecutive memory port addresses
+ */
void can_release_mem_region(unsigned long start, unsigned long n)
{
#if (LINUX_VERSION_CODE < KERNEL_VERSION(2,4,0))
#endif
}
-/* This function shifts all base address structures acording to address
- translation between physical and virtual address mappings */
+/**
+ * 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;
return 0;
}
-/* The function init_hw_struct is used to initialize the hardware structure. */
+
+/**
+ * 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;
+ int i;
+
+ if(minorbase>=0)
+ next_minor=minorbase;
+ if(next_minor>=MAX_TOT_MSGOBJS)
+ next_minor=0;
+ i=next_minor;
+ do{
+ if(objects_p[i]==NULL){
+ objects_p[i]=obj;
+ obj->minor=i;
+ next_minor=i+1;
+ return 0;
+ }
+ if(++i >= MAX_TOT_MSGOBJS) i=0;
+ }while(i!=next_minor);
+ obj->minor=-1;
+ return -1;
+}
+
+
+/**
+ * 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 chip_t *chip, int minorbase)
+{
+ static int next_chip_slot=0;
+ int i;
+
+ if(next_chip_slot>=MAX_TOT_CHIPS)
+ next_chip_slot=0;
+ i=next_chip_slot;
+ do{
+ if(chips_p[i]==NULL){
+ chips_p[i]=chip;
+
+ next_chip_slot=i+1;
+ return 0;
+ }
+ if(++i >= MAX_TOT_CHIPS) i=0;
+ }while(i!=next_chip_slot);
+ return -1;
+}
+
+
+
+/**
+ * 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;
+ int irq_param_idx=0;
+ int chan_param_idx=0;
hardware_p->nr_boards=0;
while ( (hw[i] != NULL) & (i < MAX_HW_CARDS) ) {
hardware_p->nr_boards++;
- if (init_device_struct(i)) {
+ if (init_device_struct(i, &chan_param_idx, &irq_param_idx)) {
CANMSG("Error initializing candevice_t structures.\n");
return -ENODEV;
}
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 init_device_struct(int card, int *chan_param_idx_p, int *irq_param_idx_p)
{
struct candevice_t *candev;
int ret;
+ int irqnum;
+ int chipnr;
+ long bd;
+ int irqsig=-1;
candev=(struct candevice_t *)can_checked_malloc(sizeof(struct candevice_t));
if (candev==NULL)
memset(candev->hwspecops, 0, sizeof(struct hwspecops_t));
- if (init_hwspecops(candev))
+ if (init_hwspecops(candev, &irqnum))
goto error_nodev;
if (candev->hwspecops->init_hw_data(candev))
goto error_nodev;
- if (init_chip_struct(candev))
- goto error_nodev;
+ /* Alocate and initialize the chip structures */
+ for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
+
+ if(chipnr<irqnum)
+ irqsig=irq[*irq_param_idx_p+chipnr];
+
+ bd=baudrate[*chan_param_idx_p+chipnr];
+ if(!bd) bd=baudrate[0];
+
+ if ((ret=init_chip_struct(candev, chipnr, irqsig, bd*1000)))
+ goto error_chip;
+ }
+
+
+
+ for (chipnr=0; chipnr < candev->nr_all_chips; chipnr++) {
+ int m=minor[*chan_param_idx_p+chipnr];
+ struct chip_t *chip=candev->chip[chipnr];
+ int objnr;
+
+ register_chip_struct(chip, m);
+
+ for (objnr=0; objnr<chip->max_objects; objnr++) {
+ register_obj_struct(chip->msgobj[objnr], m);
+ if(m>=0) m++;
+ }
+ }
+
+ *irq_param_idx_p += irqnum;
+ *chan_param_idx_p += candev->nr_all_chips;
return 0;
error_nodev:
- candevice_done(candev);
ret=-ENODEV;
+ error_chip:
+ candevice_done(candev);
goto error_both;
error_nomem:
}
-/* 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() function and generic
+ * init_chipspecops() function. 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 init_chip_struct(struct candevice_t *candev, int chipnr, int irq, long baudrate)
{
- static int irq_count=0;
- int i=0;
+ struct chip_t *chip;
+ int objnr;
+ int ret;
- /* Alocate and initialize the chip structures */
- for (i=0; i < candev->nr_all_chips; i++) {
- candev->chip[i]=(struct chip_t *)can_checked_malloc(sizeof(struct chip_t));
- if (candev->chip[i]==NULL)
- return -ENOMEM;
+ candev->chip[chipnr]=(struct chip_t *)can_checked_malloc(sizeof(struct chip_t));
+ if ((chip=candev->chip[chipnr])==NULL)
+ return -ENOMEM;
- memset(candev->chip[i], 0, sizeof(struct chip_t));
-
- candev->chip[i]->write_register=candev->hwspecops->write_register;
- candev->chip[i]->read_register=candev->hwspecops->read_register;
+ memset(chip, 0, sizeof(struct chip_t));
- candev->chip[i]->chipspecops=can_checked_malloc(sizeof(struct chipspecops_t));
- if (candev->chip[i]->chipspecops==NULL)
- return -ENOMEM;
+ chip->write_register=candev->hwspecops->write_register;
+ chip->read_register=candev->hwspecops->read_register;
- chips_p[irq_count]=candev->chip[i];
- candev->chip[i]->chip_idx=i;
- candev->chip[i]->hostdevice=candev;
- candev->chip[i]->chip_irq=irq[irq_count];
- candev->chip[i]->baudrate=baudrate[irq_count]*1000;
- if(!candev->chip[i]->baudrate)
- candev->chip[i]->baudrate=baudrate[0]*1000;
- candev->chip[i]->flags=0x0;
+ chip->chipspecops=can_checked_malloc(sizeof(struct chipspecops_t));
+ if (chip->chipspecops==NULL)
+ return -ENOMEM;
+ memset(chip->chipspecops,0,sizeof(struct chipspecops_t));
- candev->hwspecops->init_chip_data(candev,i);
+ chip->chip_idx=chipnr;
+ chip->hostdevice=candev;
+ chip->chip_irq=irq;
+ chip->baudrate=baudrate;
+ chip->flags=0x0;
- if (init_chipspecops(candev,i))
- return -ENODEV;
+ candev->hwspecops->init_chip_data(candev,chipnr);
- init_obj_struct(candev, candev->chip[i], minor[irq_count]);
+ if (init_chipspecops(candev,chipnr))
+ return -ENODEV;
- irq_count++;
- }
+ for (objnr=0; objnr<chip->max_objects; objnr++) {
+ ret=init_obj_struct(candev, chip, objnr);
+ if(ret<0) return ret;
+ }
return 0;
}
-int init_obj_struct(struct candevice_t *candev, struct chip_t *hostchip, int minorbase)
+
+/**
+ * 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 chip_t *hostchip, int objnr)
{
struct canque_ends_t *qends;
- static int obj_count=0;
- int i,max_objects;
struct msgobj_t *obj;
+ int ret;
- max_objects=hostchip->max_objects;
- for (i=0; i<max_objects; i++) {
- obj=(struct msgobj_t *)can_checked_malloc(sizeof(struct msgobj_t));
- hostchip->msgobj[i]=obj;
- if (obj == NULL)
- return -ENOMEM;
-
- memset(obj, 0, sizeof(struct msgobj_t));
+ obj=(struct msgobj_t *)can_checked_malloc(sizeof(struct msgobj_t));
+ hostchip->msgobj[objnr]=obj;
+ if (obj == NULL)
+ return -ENOMEM;
- atomic_set(&obj->obj_used,0);
- INIT_LIST_HEAD(&obj->obj_users);
- init_timer(&obj->tx_timeout);
-
- qends = (struct canque_ends_t *)can_checked_malloc(sizeof(struct canque_ends_t));
- if(qends == NULL) return -ENOMEM;
- memset(qends, 0, sizeof(struct canque_ends_t));
- obj->hostchip=hostchip;
- obj->object=i+1;
- obj->qends=qends;
- obj->tx_qedge=NULL;
- obj->tx_slot=NULL;
- obj->flags = 0x0;
-
- canqueue_ends_init_chip(qends, hostchip, obj);
-
- if (minorbase == -1) minorbase=obj_count;
- if ((minorbase >= 0) && (minorbase+i<MAX_TOT_MSGOBJS)){
- objects_p[minorbase+i]=obj;
- obj->minor=minorbase+i;
- } else obj->minor=-1;
+ memset(obj, 0, sizeof(struct msgobj_t));
+ obj->minor=-1;
- candev->hwspecops->init_obj_data(hostchip,i);
+ atomic_set(&obj->obj_used,0);
+ INIT_LIST_HEAD(&obj->obj_users);
+ init_timer(&obj->tx_timeout);
- obj_count++;
- }
+ qends = (struct canque_ends_t *)can_checked_malloc(sizeof(struct canque_ends_t));
+ if(qends == NULL) return -ENOMEM;
+ memset(qends, 0, sizeof(struct canque_ends_t));
+ obj->hostchip=hostchip;
+ obj->object=objnr+1;
+ obj->qends=qends;
+ obj->tx_qedge=NULL;
+ obj->tx_slot=NULL;
+ obj->obj_flags = 0x0;
+
+ ret=canqueue_ends_init_chip(qends, hostchip, obj);
+ if(ret<0) return ret;
+
+ ret=candev->hwspecops->init_obj_data(hostchip,objnr);
+ if(ret<0) return ret;
+
return 0;
}
-int init_hwspecops(struct candevice_t *candev)
+/**
+ * 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;
return -EINVAL;
}
+ if(irqnum_p)
+ *irqnum_p=brp->irqnum;
brp->board_register(candev->hwspecops);
return 0;
}
+
+/**
+ * init_chipspecops - fills chip specific operations for board for known chip types
+ * @candev: pointer to the corresponding CAN device/board
+ * @chipnr: index of the chip in the device/board structure
+ *
+ * The function fills chip specific operations for next known generic chip
+ * types "i82527", "sja1000", "sja1000p" (PeliCAN). Other non generic chip types
+ * operations has to be initialized in the board specific init_chip_data() function.
+ *
+ * Return Value: returns negative number in the case of fail
+ */
int init_chipspecops(struct candevice_t *candev, int chipnr)
{
if (!strcmp(candev->chip[chipnr]->chip_type,"i82527")) {
return 0;
}
+
+#ifndef CAN_WITH_RTL
+
+/**
+ * can_chip_setup_irq - attaches chip to the system interrupt processing
+ * @chip: pointer to CAN chip structure
+ *
+ * Return Value: returns negative number in the case of fail
+ */
+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;
+}
+
+
+/**
+ * can_chip_free_irq - unregisters chip interrupt handler from the system
+ * @chip: pointer to CAN chip structure
+ */
+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*/
projects / lincan.git / blobdiff