lincan/src/virtual.c

   1 /* virtual.c
   2  * Linux CAN-bus device driver.
   3  * Written for new CAN driver version by Pavel Pisa - OCERA team member
   4  * email:pisa@cmp.felk.cvut.cz
   5  * This software is released under the GPL-License.
   6  * Version lincan-0.3  17 Jun 2004
   7  */
   8
   9 #include "../include/can.h"
  10 #include "../include/can_sysdep.h"
  11 #include "../include/main.h"
  12
  13
  14 long virtual_bus_latency(struct msgobj_t *obj)
  15 {
  16         long latency;
  17         latency=obj->hostchip->baudrate;
  18         if(latency){
  19                 latency=(long)HZ*1000/latency;
  20         }
  21         return latency;
  22 }
  23
  24
  25 /* * * Virtual Chip Functionality * * */
  26
  27 int virtual_enable_configuration(struct chip_t *chip)
  28 {
  29         return 0;
  30 }
  31
  32 int virtual_disable_configuration(struct chip_t *chip)
  33 {
  34         return 0;
  35 }
  36
  37 /**
  38  * virtual_chip_config: - can chip configuration
  39  * @chip: pointer to chip state structure
  40  *
  41  * Return Value: negative value reports error.
  42  * File: src/virtual.c
  43  */
  44 int virtual_chip_config(struct chip_t *chip)
  45 {
  46         return 0;
  47 }
  48
  49 /**
  50  * virtual_extended_mask: - setup of extended mask for message filtering
  51  * @chip: pointer to chip state structure
  52  * @code: can message acceptance code
  53  * @mask: can message acceptance mask
  54  *
  55  * Return Value: negative value reports error.
  56  * File: src/virtual.c
  57  */
  58 int virtual_extended_mask(struct chip_t *chip, unsigned long code, unsigned  long mask)
  59 {
  60         return 0;
  61 }
  62
  63 /**
  64  * virtual_baud_rate: - set communication parameters.
  65  * @chip: pointer to chip state structure
  66  * @rate: baud rate in Hz
  67  * @clock: frequency of sja1000 clock in Hz (ISA osc is 14318000)
  68  * @sjw: synchronization jump width (0-3) prescaled clock cycles
  69  * @sampl_pt: sample point in % (0-100) sets (TSEG1+1)/(TSEG1+TSEG2+2) ratio
  70  * @flags: fields %BTR1_SAM, %OCMODE, %OCPOL, %OCTP, %OCTN, %CLK_OFF, %CBP
  71  *
  72  * Return Value: negative value reports error.
  73  * File: src/virtual.c
  74  */
  75 int virtual_baud_rate(struct chip_t *chip, int rate, int clock, int sjw,
  76                                                         int sampl_pt, int flags)
  77 {
  78         return 0;
  79 }
  80
  81 /**
  82  * virtual_read: - reads and distributes one or more received messages
  83  * @chip: pointer to chip state structure
  84  * @obj: pinter to CAN message queue information
  85  *
  86  * File: src/virtual.c
  87  */
  88 void virtual_read(struct chip_t *chip, struct msgobj_t *obj) {
  89
  90 }
  91
  92 /**
  93  * virtual_pre_read_config: - prepares message object for message reception
  94  * @chip: pointer to chip state structure
  95  * @obj: pointer to message object state structure
  96  *
  97  * Return Value: negative value reports error.
  98  *      Positive value indicates immediate reception of message.
  99  * File: src/virtual.c
 100  */
 101 int virtual_pre_read_config(struct chip_t *chip, struct msgobj_t *obj)
 102 {
 103         return 0;
 104 }
 105
 106 #define MAX_TRANSMIT_WAIT_LOOPS 10
 107 /**
 108  * virtual_pre_write_config: - prepares message object for message transmission
 109  * @chip: pointer to chip state structure
 110  * @obj: pointer to message object state structure
 111  * @msg: pointer to CAN message
 112  *
 113  * Return Value: negative value reports error.
 114  * File: src/virtual.c
 115  */
 116 int virtual_pre_write_config(struct chip_t *chip, struct msgobj_t *obj,
 117                                                         struct canmsg_t *msg)
 118 {
 119         return 0;
 120 }
 121
 122 /**
 123  * virtual_send_msg: - initiate message transmission
 124  * @chip: pointer to chip state structure
 125  * @obj: pointer to message object state structure
 126  * @msg: pointer to CAN message
 127  *
 128  * This function is called after virtual_pre_write_config() function,
 129  * which prepares data in chip buffer.
 130  * Return Value: negative value reports error.
 131  * File: src/virtual.c
 132  */
 133 int virtual_send_msg(struct chip_t *chip, struct msgobj_t *obj,
 134                                                         struct canmsg_t *msg)
 135 {
 136         return 0;
 137 }
 138
 139 /**
 140  * virtual_check_tx_stat: - checks state of transmission engine
 141  * @chip: pointer to chip state structure
 142  *
 143  * Return Value: negative value reports error.
 144  *      Positive return value indicates transmission under way status.
 145  *      Zero value indicates finishing of all issued transmission requests.
 146  * File: src/virtual.c
 147  */
 148 int virtual_check_tx_stat(struct chip_t *chip)
 149 {
 150         return 0;
 151 }
 152
 153 /**
 154  * virtual_set_btregs: -  configures bitrate registers
 155  * @chip: pointer to chip state structure
 156  * @btr0: bitrate register 0
 157  * @btr1: bitrate register 1
 158  *
 159  * Return Value: negative value reports error.
 160  * File: src/virtual.c
 161  */
 162 int virtual_set_btregs(struct chip_t *chip, unsigned short btr0,
 163                                                         unsigned short btr1)
 164 {
 165         return 0;
 166 }
 167
 168 /**
 169  * virtual_stop_chip: -  starts chip message processing
 170  * @chip: pointer to chip state structure
 171  *
 172  * Return Value: negative value reports error.
 173  * File: src/virtual.c
 174  */
 175 int virtual_start_chip(struct chip_t *chip)
 176 {
 177         return 0;
 178 }
 179
 180 /**
 181  * virtual_stop_chip: -  stops chip message processing
 182  * @chip: pointer to chip state structure
 183  *
 184  * Return Value: negative value reports error.
 185  * File: src/virtual.c
 186  */
 187 int virtual_stop_chip(struct chip_t *chip)
 188 {
 189         return 0;
 190 }
 191
 192
 193 /**
 194  * virtual_remote_request: - configures message object and asks for RTR message
 195  * @chip: pointer to chip state structure
 196  * @obj: pointer to message object structure
 197  *
 198  * Return Value: negative value reports error.
 199  * File: src/virtual.c
 200  */
 201 int virtual_remote_request(struct chip_t *chip, struct msgobj_t *obj)
 202 {
 203         CANMSG("virtual_remote_request not implemented\n");
 204         return -ENOSYS;
 205 }
 206
 207 /**
 208  * virtual_standard_mask: - setup of mask for message filtering
 209  * @chip: pointer to chip state structure
 210  * @code: can message acceptance code
 211  * @mask: can message acceptance mask
 212  *
 213  * Return Value: negative value reports error.
 214  * File: src/virtual.c
 215  */
 216 int virtual_standard_mask(struct chip_t *chip, unsigned short code,
 217                 unsigned short mask)
 218 {
 219         CANMSG("virtual_standard_mask not implemented\n");
 220         return -ENOSYS;
 221 }
 222
 223 /**
 224  * virtual_clear_objects: - clears state of all message object residing in chip
 225  * @chip: pointer to chip state structure
 226  *
 227  * Return Value: negative value reports error.
 228  * File: src/virtual.c
 229  */
 230 int virtual_clear_objects(struct chip_t *chip)
 231 {
 232         CANMSG("virtual_clear_objects not implemented\n");
 233         return -ENOSYS;
 234 }
 235
 236 /**
 237  * virtual_config_irqs: - tunes chip hardware interrupt delivery
 238  * @chip: pointer to chip state structure
 239  * @irqs: requested chip IRQ configuration
 240  *
 241  * Return Value: negative value reports error.
 242  * File: src/virtual.c
 243  */
 244 int virtual_config_irqs(struct chip_t *chip, short irqs)
 245 {
 246         CANMSG("virtual_config_irqs not implemented\n");
 247         return -ENOSYS;
 248 }
 249
 250 /**
 251  * virtual_irq_write_handler: - part of ISR code responsible for transmit events
 252  * @chip: pointer to chip state structure
 253  * @obj: pointer to attached queue description
 254  *
 255  * The main purpose of this function is to read message from attached queues
 256  * and transfer message contents into CAN controller chip.
 257  * This subroutine is called by
 258  * virtual_irq_write_handler() for transmit events.
 259  * File: src/virtual.c
 260  */
 261 void virtual_irq_write_handler(struct chip_t *chip, struct msgobj_t *obj)
 262 {
 263
 264 }
 265
 266 #define MAX_RETR 10
 267
 268 /**
 269  * virtual_irq_handler: - interrupt service routine
 270  * @irq: interrupt vector number, this value is system specific
 271  * @dev_id: driver private pointer registered at time of request_irq() call.
 272  *      The CAN driver uses this pointer to store relationship of interrupt
 273  *      to chip state structure - @struct chip_t
 274  * @regs: system dependent value pointing to registers stored in exception frame
 275  *
 276  * Interrupt handler is activated when state of CAN controller chip changes,
 277  * there is message to be read or there is more space for new messages or
 278  * error occurs. The receive events results in reading of the message from
 279  * CAN controller chip and distribution of message through attached
 280  * message queues.
 281  * File: src/virtual.c
 282  */
 283 int virtual_irq_handler(int irq, struct chip_t *chip)
 284 {
 285         return CANCHIP_IRQ_HANDLED;
 286 }
 287
 288
 289 void virtual_schedule_next(struct msgobj_t *obj)
 290 {
 291         int cmd;
 292
 293         can_preempt_disable();
 294
 295         can_msgobj_set_fl(obj,TX_REQUEST);
 296
 297         while(!can_msgobj_test_and_set_fl(obj,TX_LOCK)){
 298
 299                 can_msgobj_clear_fl(obj,TX_REQUEST);
 300
 301                 cmd=canque_test_outslot(obj->qends, &obj->tx_qedge, &obj->tx_slot);
 302                 if(cmd>=0) {
 303                         mod_timer(&obj->tx_timeout,
 304                                 jiffies+virtual_bus_latency(obj));
 305                         DEBUGMSG("virtual: scheduled delivery\n");
 306
 307                 } else
 308                         can_msgobj_clear_fl(obj,TX_LOCK);
 309
 310                 if(!can_msgobj_test_fl(obj,TX_REQUEST)) break;
 311                 DEBUGMSG("TX looping in virtual_schedule_next\n");
 312         }
 313
 314         can_preempt_enable();
 315 }
 316
 317
 318 void virtual_do_tx_timeout(unsigned long data)
 319 {
 320         struct msgobj_t *obj=(struct msgobj_t *)data;
 321
 322         if(obj->tx_slot) {
 323                 /* fill CAN message timestamp */
 324                 can_filltimestamp(&obj->tx_slot->msg.timestamp);
 325
 326                 /* Deliver message to edges */
 327                 canque_filter_msg2edges(obj->qends, &obj->tx_slot->msg);
 328                 /* Free transmitted slot */
 329                 canque_free_outslot(obj->qends, obj->tx_qedge, obj->tx_slot);
 330                 obj->tx_slot=NULL;
 331                 DEBUGMSG("virtual: delayed delivery\n");
 332         }
 333         can_msgobj_clear_fl(obj,TX_LOCK);
 334
 335         virtual_schedule_next(obj);
 336 }
 337
 338 /**
 339  * virtual_wakeup_tx: - wakeups TX processing
 340  * @chip: pointer to chip state structure
 341  * @obj: pointer to message object structure
 342  *
 343  * Function is responsible for initiating message transmition.
 344  * It is responsible for clearing of object TX_REQUEST flag
 345  *
 346  * Return Value: negative value reports error.
 347  * File: src/virtual.c
 348  */
 349 int virtual_wakeup_tx(struct chip_t *chip, struct msgobj_t *obj)
 350 {
 351         /* can_msgobj_set_fl(obj,TX_REQUEST); */
 352
 353         struct canque_edge_t *qedge;
 354         struct canque_slot_t *slot;
 355         int cmd;
 356
 357         can_msgobj_clear_fl(obj,TX_REQUEST);
 358
 359     #ifndef CAN_WITH_RTL
 360         if(!virtual_bus_latency(obj)) {
 361     #endif /*CAN_WITH_RTL*/
 362                 /* Ensure delivery of all ready slots */
 363                 while((cmd=canque_test_outslot(obj->qends, &qedge, &slot)) >= 0){
 364                         if(cmd==0) {
 365                                 /* fill CAN message timestamp */
 366                                 can_filltimestamp(&slot->msg.timestamp);
 367
 368                                 canque_filter_msg2edges(obj->qends, &slot->msg);
 369                                 DEBUGMSG("virtual: direct delivery\n");
 370                         }
 371                         canque_free_outslot(obj->qends, qedge, slot);
 372                 }
 373     #ifndef CAN_WITH_RTL
 374         } else {
 375                 virtual_schedule_next(obj);
 376         }
 377     #endif /*CAN_WITH_RTL*/
 378
 379         return 0;
 380 }
 381
 382
 383 /* * * Virtual Board Functionality * * */
 384
 385 /**
 386  * virtual_request_io: - reserve io or memory range for can board
 387  * @candev: pointer to candevice/board which asks for io. Field @io_addr
 388  *      of @candev is used in most cases to define start of the range
 389  *
 390  * Return Value: The function returns zero on success or %-ENODEV on failure
 391  * File: src/virtual.c
 392  */
 393 int virtual_request_io(struct candevice_t *candev)
 394 {
 395         return 0;
 396 }
 397
 398 /**
 399  * virtual_elease_io - free reserved io memory range
 400  * @candev: pointer to candevice/board which releases io
 401  *
 402  * Return Value: The function always returns zero
 403  * File: src/virtual.c
 404  */
 405 int virtual_release_io(struct candevice_t *candev)
 406 {
 407         return 0;
 408 }
 409
 410 /**
 411  * virtual_reset - hardware reset routine
 412  * @candev: Pointer to candevice/board structure
 413  *
 414  * Return Value: The function returns zero on success or %-ENODEV on failure
 415  * File: src/virtual.c
 416  */
 417 int virtual_reset(struct candevice_t *candev)
 418 {
 419         return 0;
 420 }
 421
 422 /**
 423  * virtual_init_hw_data - Initialize hardware cards
 424  * @candev: Pointer to candevice/board structure
 425  *
 426  * Return Value: The function always returns zero
 427  * File: src/virtual.c
 428  */
 429 int virtual_init_hw_data(struct candevice_t *candev)
 430 {
 431         candev->res_addr=0;
 432         candev->nr_82527_chips=0;
 433         candev->nr_sja1000_chips=0;
 434         candev->nr_all_chips=1;
 435         candev->flags |= CANDEV_PROGRAMMABLE_IRQ*0;
 436
 437         return 0;
 438 }
 439
 440 #define CHIP_TYPE "virtual"
 441
 442 /**
 443  * virtual_init_chip_data - Initialize chips
 444  * @candev: Pointer to candevice/board structure
 445  * @chipnr: Number of the CAN chip on the hardware card
 446  *
 447  * Return Value: The function always returns zero
 448  * File: src/virtual.c
 449  */
 450 int virtual_init_chip_data(struct candevice_t *candev, int chipnr)
 451 {
 452         struct chip_t *chip = candev->chip[chipnr];
 453         chip->chip_type = CHIP_TYPE;
 454         chip->chip_base_addr = 0;
 455         chip->clock = 10000000;
 456         chip->int_clk_reg = 0x0;
 457         chip->int_bus_reg = 0x0;
 458         chip->max_objects = 1;
 459
 460         CANMSG("initializing virtual chip operations\n");
 461         chip->chipspecops->chip_config=virtual_chip_config;
 462         chip->chipspecops->baud_rate=virtual_baud_rate;
 463         chip->chipspecops->standard_mask=virtual_standard_mask;
 464         chip->chipspecops->extended_mask=virtual_extended_mask;
 465         chip->chipspecops->message15_mask=virtual_extended_mask;
 466         chip->chipspecops->clear_objects=virtual_clear_objects;
 467         chip->chipspecops->config_irqs=virtual_config_irqs;
 468         chip->chipspecops->pre_read_config=virtual_pre_read_config;
 469         chip->chipspecops->pre_write_config=virtual_pre_write_config;
 470         chip->chipspecops->send_msg=virtual_send_msg;
 471         chip->chipspecops->check_tx_stat=virtual_check_tx_stat;
 472         chip->chipspecops->wakeup_tx=virtual_wakeup_tx;
 473         chip->chipspecops->remote_request=virtual_remote_request;
 474         chip->chipspecops->enable_configuration=virtual_enable_configuration;
 475         chip->chipspecops->disable_configuration=virtual_disable_configuration;
 476         chip->chipspecops->set_btregs=virtual_set_btregs;
 477         chip->chipspecops->start_chip=virtual_start_chip;
 478         chip->chipspecops->stop_chip=virtual_stop_chip;
 479         chip->chipspecops->irq_handler=NULL;
 480
 481         return 0;
 482 }
 483
 484 /**
 485  * virtual_init_obj_data - Initialize message buffers
 486  * @chip: Pointer to chip specific structure
 487  * @objnr: Number of the message buffer
 488  *
 489  * Return Value: The function always returns zero
 490  * File: src/virtual.c
 491  */
 492 int virtual_init_obj_data(struct chip_t *chip, int objnr)
 493 {
 494         struct msgobj_t *obj=chip->msgobj[objnr];
 495         obj->obj_base_addr=chip->chip_base_addr;
 496         obj->tx_timeout.function=virtual_do_tx_timeout;
 497         obj->tx_timeout.data=(unsigned long)obj;
 498         return 0;
 499 }
 500
 501 /**
 502  * virtual_program_irq - program interrupts
 503  * @candev: Pointer to candevice/board structure
 504  *
 505  * Return value: The function returns zero on success or %-ENODEV on failure
 506  * File: src/virtual.c
 507  */
 508 int virtual_program_irq(struct candevice_t *candev)
 509 {
 510         return 0;
 511 }
 512
 513 int virtual_register(struct hwspecops_t *hwspecops)
 514 {
 515         hwspecops->request_io = virtual_request_io;
 516         hwspecops->release_io = virtual_release_io;
 517         hwspecops->reset = virtual_reset;
 518         hwspecops->init_hw_data = virtual_init_hw_data;
 519         hwspecops->init_chip_data = virtual_init_chip_data;
 520         hwspecops->init_obj_data = virtual_init_obj_data;
 521         hwspecops->write_register = NULL;
 522         hwspecops->read_register = NULL;
 523         hwspecops->program_irq = virtual_program_irq;
 524         return 0;
 525 }