2 * Linux CAN-bus device driver.
3 * Written by Arnaud Westenberg email:arnaud@wanadoo.nl
4 * Changed for PeliCan mode SJA1000 by Tomasz Motylewski (BFAD GmbH)
6 * Rewritten for new CAN queues by Pavel Pisa - OCERA team member
7 * email:pisa@cmp.felk.cvut.cz
8 * This software is released under the GPL-License.
9 * Version lincan-0.2 9 Jul 2003
12 #include <linux/autoconf.h>
14 #include <linux/sched.h>
15 #include <linux/delay.h>
18 #include "../include/main.h"
19 #include "../include/sja1000p.h"
22 * sja1000p_enable_configuration - enable chip configuration mode
23 * @chip: pointer to chip state structure
25 int sja1000p_enable_configuration(struct chip_t *chip)
28 enum sja1000_PeliCAN_MOD flags;
30 disable_irq(chip->chip_irq);
32 flags=can_read_reg(chip,SJAMOD);
34 while ((!(flags & MOD_RM)) && (i<=10)) {
35 can_write_reg(chip, MOD_RM, SJAMOD);
36 // TODO: configurable MOD_AFM (32/16 bit acceptance filter)
37 // config MOD_LOM (listen only)
40 flags=can_read_reg(chip, SJAMOD);
43 CANMSG("Reset error\n");
44 enable_irq(chip->chip_irq);
52 * sja1000p_disable_configuration - disable chip configuration mode
53 * @chip: pointer to chip state structure
55 int sja1000p_disable_configuration(struct chip_t *chip)
58 enum sja1000_PeliCAN_MOD flags;
60 flags=can_read_reg(chip,SJAMOD);
62 while ( (flags & MOD_RM) && (i<=50) ) {
63 // could be as long as 11*128 bit times after buss-off
64 can_write_reg(chip, 0, SJAMOD);
65 // TODO: configurable MOD_AFM (32/16 bit acceptance filter)
66 // config MOD_LOM (listen only)
69 flags=can_read_reg(chip, SJAMOD);
72 CANMSG("Error leaving reset status\n");
76 enable_irq(chip->chip_irq);
82 * sja1000p_chip_config: - can chip configuration
83 * @chip: pointer to chip state structure
85 * This function configures chip and prepares it for message
86 * transmission and reception. The function resets chip,
87 * resets mask for acceptance of all messages by call to
88 * sja1000p_extended_mask() function and then
89 * computes and sets baudrate with use of function sja1000p_baud_rate().
90 * Return Value: negative value reports error.
91 * File: src/sja1000p.c
93 int sja1000p_chip_config(struct chip_t *chip)
98 if (sja1000p_enable_configuration(chip))
101 /* Set mode, clock out, comparator */
102 can_write_reg(chip,CDR_PELICAN|chip->sja_cdr_reg,SJACDR);
103 /* Set driver output configuration */
104 can_write_reg(chip,chip->sja_ocr_reg,SJAOCR);
106 /* Simple check for chip presence */
107 for (i=0, n=0x5a; i<8; i++, n+=0xf) {
108 can_write_reg(chip,n,SJAACR0+i);
110 for (i=0, n=0x5a; i<8; i++, n+=0xf) {
111 r = n^can_read_reg(chip,SJAACR0+i);
113 CANMSG("sja1000p_chip_config: chip connection broken,"
114 " readback differ 0x%02x\n", r);
120 if (sja1000p_extended_mask(chip,0x00000000, 0xffffffff))
125 if (sja1000p_baud_rate(chip,1000*baudrate,chip->clock,0,75,0))
128 /* Enable hardware interrupts */
129 can_write_reg(chip, ENABLE_INTERRUPTS, SJAIER);
131 sja1000p_disable_configuration(chip);
137 * sja1000p_extended_mask: - setup of extended mask for message filtering
138 * @chip: pointer to chip state structure
139 * @code: can message acceptance code
140 * @mask: can message acceptance mask
142 * Return Value: negative value reports error.
143 * File: src/sja1000p.c
145 int sja1000p_extended_mask(struct chip_t *chip, unsigned long code, unsigned long mask)
149 if (sja1000p_enable_configuration(chip))
152 // LSB to +3, MSB to +0
153 for(i=SJA_PeliCAN_AC_LEN; --i>=0;) {
154 can_write_reg(chip,code&0xff,SJAACR0+i);
155 can_write_reg(chip,mask&0xff,SJAAMR0+i);
160 DEBUGMSG("Setting acceptance code to 0x%lx\n",(unsigned long)code);
161 DEBUGMSG("Setting acceptance mask to 0x%lx\n",(unsigned long)mask);
163 sja1000p_disable_configuration(chip);
169 * sja1000p_baud_rate: - set communication parameters.
170 * @chip: pointer to chip state structure
171 * @rate: baud rate in Hz
172 * @clock: frequency of sja1000 clock in Hz (ISA osc is 14318000)
173 * @sjw: synchronization jump width (0-3) prescaled clock cycles
174 * @sampl_pt: sample point in % (0-100) sets (TSEG1+1)/(TSEG1+TSEG2+2) ratio
175 * @flags: fields %BTR1_SAM, %OCMODE, %OCPOL, %OCTP, %OCTN, %CLK_OFF, %CBP
177 * Return Value: negative value reports error.
178 * File: src/sja1000p.c
180 int sja1000p_baud_rate(struct chip_t *chip, int rate, int clock, int sjw,
181 int sampl_pt, int flags)
183 int best_error = 1000000000, error;
184 int best_tseg=0, best_brp=0, best_rate=0, brp=0;
185 int tseg=0, tseg1=0, tseg2=0;
187 if (sja1000p_enable_configuration(chip))
192 /* tseg even = round down, odd = round up */
193 for (tseg=(0+0+2)*2; tseg<=(MAX_TSEG2+MAX_TSEG1+2)*2+1; tseg++) {
194 brp = clock/((1+tseg/2)*rate)+tseg%2;
195 if (brp == 0 || brp > 64)
197 error = rate - clock/(brp*(1+tseg/2));
200 if (error <= best_error) {
204 best_rate = clock/(brp*(1+tseg/2));
207 if (best_error && (rate/best_error < 10)) {
208 CANMSG("baud rate %d is not possible with %d Hz clock\n",
210 CANMSG("%d bps. brp=%d, best_tseg=%d, tseg1=%d, tseg2=%d\n",
211 best_rate, best_brp, best_tseg, tseg1, tseg2);
214 tseg2 = best_tseg-(sampl_pt*(best_tseg+1))/100;
217 if (tseg2 > MAX_TSEG2)
219 tseg1 = best_tseg-tseg2-2;
220 if (tseg1>MAX_TSEG1) {
222 tseg2 = best_tseg-tseg1-2;
225 DEBUGMSG("Setting %d bps.\n", best_rate);
226 DEBUGMSG("brp=%d, best_tseg=%d, tseg1=%d, tseg2=%d, sampl_pt=%d\n",
227 best_brp, best_tseg, tseg1, tseg2,
228 (100*(best_tseg-tseg2)/(best_tseg+1)));
231 can_write_reg(chip, sjw<<6 | best_brp, SJABTR0);
232 can_write_reg(chip, ((flags & BTR1_SAM) != 0)<<7 | (tseg2<<4)
235 sja1000p_disable_configuration(chip);
241 * sja1000p_read: - reads and distributes one or more received messages
242 * @chip: pointer to chip state structure
243 * @obj: pinter to CAN message queue information
245 * File: src/sja1000p.c
247 void sja1000p_read(struct chip_t *chip, struct msgobj_t *obj) {
248 int i, flags, len, datastart;
250 flags = can_read_reg(chip,SJAFRM);
253 (can_read_reg(chip,SJAID0)<<21) +
254 (can_read_reg(chip,SJAID1)<<13) +
255 (can_read_reg(chip,SJAID2)<<5) +
256 (can_read_reg(chip,SJAID3)>>3);
260 (can_read_reg(chip,SJAID0)<<3) +
261 (can_read_reg(chip,SJAID1)>>5);
265 ((flags & FRM_RTR) ? MSG_RTR : 0) |
266 ((flags & FRM_FF) ? MSG_EXT : 0);
267 len = flags & FRM_DLC_M;
268 obj->rx_msg.length = len;
269 if(len > CAN_MSG_LENGTH) len = CAN_MSG_LENGTH;
270 for(i=0; i< len; i++) {
271 obj->rx_msg.data[i]=can_read_reg(chip,datastart+i);
274 canque_filter_msg2edges(obj->qends, &obj->rx_msg);
276 can_write_reg(chip, CMR_RRB, SJACMR);
278 } while (can_read_reg(chip, SJASR) & SR_RBS);
282 * sja1000p_pre_read_config: - prepares message object for message reception
283 * @chip: pointer to chip state structure
284 * @obj: pointer to message object state structure
286 * Return Value: negative value reports error.
287 * Positive value indicates immediate reception of message.
288 * File: src/sja1000p.c
290 int sja1000p_pre_read_config(struct chip_t *chip, struct msgobj_t *obj)
293 status=can_read_reg(chip,SJASR);
296 /* Try to recover from error condition */
297 DEBUGMSG("sja1000p_pre_read_config bus-off recover 0x%x\n",status);
298 sja1000p_enable_configuration(chip);
299 can_write_reg(chip, 0, SJARXERR);
300 can_write_reg(chip, 0, SJATXERR1);
301 can_read_reg(chip, SJAECC);
302 sja1000p_disable_configuration(chip);
305 if (!(status&SR_RBS)) {
309 can_write_reg(chip, DISABLE_INTERRUPTS, SJAIER); //disable interrupts for a moment
310 sja1000p_read(chip, obj);
311 can_write_reg(chip, ENABLE_INTERRUPTS, SJAIER); //enable interrupts
315 #define MAX_TRANSMIT_WAIT_LOOPS 10
317 * sja1000p_pre_write_config: - prepares message object for message transmission
318 * @chip: pointer to chip state structure
319 * @obj: pointer to message object state structure
320 * @msg: pointer to CAN message
322 * This function prepares selected message object for future initiation
323 * of message transmission by sja1000p_send_msg() function.
324 * The CAN message data and message ID are transfered from @msg slot
325 * into chip buffer in this function.
326 * Return Value: negative value reports error.
327 * File: src/sja1000p.c
329 int sja1000p_pre_write_config(struct chip_t *chip, struct msgobj_t *obj,
330 struct canmsg_t *msg)
337 /* Wait until Transmit Buffer Status is released */
338 while ( !((status=can_read_reg(chip, SJASR)) & SR_TBS) &&
339 i++<MAX_TRANSMIT_WAIT_LOOPS) {
344 /* Try to recover from error condition */
345 DEBUGMSG("sja1000p_pre_write_config bus-off recover 0x%x\n",status);
346 sja1000p_enable_configuration(chip);
347 can_write_reg(chip, 0, SJARXERR);
348 can_write_reg(chip, 0, SJATXERR1);
349 can_read_reg(chip, SJAECC);
350 sja1000p_disable_configuration(chip);
352 if (!(can_read_reg(chip, SJASR) & SR_TBS)) {
353 CANMSG("Transmit timed out, cancelling\n");
354 // here we should check if there is no write/select waiting for this
355 // transmit. If so, set error ret and wake up.
356 // CHECKME: if we do not disable IER_TIE (TX IRQ) here we get interrupt
358 can_write_reg(chip, CMR_AT, SJACMR);
360 while ( !(can_read_reg(chip, SJASR) & SR_TBS) &&
361 i++<MAX_TRANSMIT_WAIT_LOOPS) {
364 if (!(can_read_reg(chip, SJASR) & SR_TBS)) {
365 CANMSG("Could not cancel, please reset\n");
370 if(len > CAN_MSG_LENGTH) len = CAN_MSG_LENGTH;
371 /* len &= FRM_DLC_M; ensured by above condition already */
372 can_write_reg(chip, ((msg->flags&MSG_EXT)?FRM_FF:0) |
373 ((msg->flags & MSG_RTR) ? FRM_RTR : 0) | len, SJAFRM);
374 if(msg->flags&MSG_EXT) {
376 can_write_reg(chip, id & 0xff, SJAID3);
378 can_write_reg(chip, id & 0xff, SJAID2);
380 can_write_reg(chip, id & 0xff, SJAID1);
382 can_write_reg(chip, id, SJAID0);
383 for(i=0; i < len; i++) {
384 can_write_reg(chip, msg->data[i], SJADATE+i);
388 can_write_reg(chip, (id >> 8) & 0xff, SJAID0);
389 can_write_reg(chip, id & 0xff, SJAID1);
390 for(i=0; i < len; i++) {
391 can_write_reg(chip, msg->data[i], SJADATS+i);
398 * sja1000p_send_msg: - initiate message transmission
399 * @chip: pointer to chip state structure
400 * @obj: pointer to message object state structure
401 * @msg: pointer to CAN message
403 * This function is called after sja1000p_pre_write_config() function,
404 * which prepares data in chip buffer.
405 * Return Value: negative value reports error.
406 * File: src/sja1000p.c
408 int sja1000p_send_msg(struct chip_t *chip, struct msgobj_t *obj,
409 struct canmsg_t *msg)
411 can_write_reg(chip, CMR_TR, SJACMR);
417 * sja1000p_check_tx_stat: - checks state of transmission engine
418 * @chip: pointer to chip state structure
420 * Return Value: negative value reports error.
421 * Positive return value indicates transmission under way status.
422 * Zero value indicates finishing of all issued transmission requests.
423 * File: src/sja1000p.c
425 int sja1000p_check_tx_stat(struct chip_t *chip)
427 if (can_read_reg(chip,SJASR) & SR_TCS)
434 * sja1000p_set_btregs: - configures bitrate registers
435 * @chip: pointer to chip state structure
436 * @btr0: bitrate register 0
437 * @btr1: bitrate register 1
439 * Return Value: negative value reports error.
440 * File: src/sja1000p.c
442 int sja1000p_set_btregs(struct chip_t *chip, unsigned short btr0,
445 if (sja1000p_enable_configuration(chip))
448 can_write_reg(chip, btr0, SJABTR0);
449 can_write_reg(chip, btr1, SJABTR1);
451 sja1000p_disable_configuration(chip);
457 * sja1000p_start_chip: - starts chip message processing
458 * @chip: pointer to chip state structure
460 * Return Value: negative value reports error.
461 * File: src/sja1000p.c
463 int sja1000p_start_chip(struct chip_t *chip)
465 enum sja1000_PeliCAN_MOD flags;
467 flags = can_read_reg(chip, SJAMOD) & (MOD_LOM|MOD_STM|MOD_AFM|MOD_SM);
468 can_write_reg(chip, flags, SJAMOD);
474 * sja1000p_stop_chip: - stops chip message processing
475 * @chip: pointer to chip state structure
477 * Return Value: negative value reports error.
478 * File: src/sja1000p.c
480 int sja1000p_stop_chip(struct chip_t *chip)
482 enum sja1000_PeliCAN_MOD flags;
484 flags = can_read_reg(chip, SJAMOD) & (MOD_LOM|MOD_STM|MOD_AFM|MOD_SM);
485 can_write_reg(chip, flags|MOD_RM, SJAMOD);
492 * sja1000p_remote_request: - configures message object and asks for RTR message
493 * @chip: pointer to chip state structure
494 * @obj: pointer to message object structure
496 * Return Value: negative value reports error.
497 * File: src/sja1000p.c
499 int sja1000p_remote_request(struct chip_t *chip, struct msgobj_t *obj)
501 CANMSG("sja1000p_remote_request not implemented\n");
506 * sja1000p_standard_mask: - setup of mask for message filtering
507 * @chip: pointer to chip state structure
508 * @code: can message acceptance code
509 * @mask: can message acceptance mask
511 * Return Value: negative value reports error.
512 * File: src/sja1000p.c
514 int sja1000p_standard_mask(struct chip_t *chip, unsigned short code,
517 CANMSG("sja1000p_standard_mask not implemented\n");
522 * sja1000p_clear_objects: - clears state of all message object residing in chip
523 * @chip: pointer to chip state structure
525 * Return Value: negative value reports error.
526 * File: src/sja1000p.c
528 int sja1000p_clear_objects(struct chip_t *chip)
530 CANMSG("sja1000p_clear_objects not implemented\n");
535 * sja1000p_config_irqs: - tunes chip hardware interrupt delivery
536 * @chip: pointer to chip state structure
537 * @irqs: requested chip IRQ configuration
539 * Return Value: negative value reports error.
540 * File: src/sja1000p.c
542 int sja1000p_config_irqs(struct chip_t *chip, short irqs)
544 CANMSG("sja1000p_config_irqs not implemented\n");
549 * sja1000p_irq_write_handler: - part of ISR code responsible for transmit events
550 * @chip: pointer to chip state structure
551 * @obj: pointer to attached queue description
553 * The main purpose of this function is to read message from attached queues
554 * and transfer message contents into CAN controller chip.
555 * This subroutine is called by
556 * sja1000p_irq_write_handler() for transmit events.
557 * File: src/sja1000p.c
559 void sja1000p_irq_write_handler(struct chip_t *chip, struct msgobj_t *obj)
564 /* Do local transmitted message distribution if enabled */
566 obj->tx_slot->msg.flags |= MSG_LOCAL;
567 canque_filter_msg2edges(obj->qends, &obj->tx_slot->msg);
569 /* Free transmitted slot */
570 canque_free_outslot(obj->qends, obj->tx_qedge, obj->tx_slot);
574 cmd=canque_test_outslot(obj->qends, &obj->tx_qedge, &obj->tx_slot);
578 if (chip->chipspecops->pre_write_config(chip, obj, &obj->tx_slot->msg)) {
580 canque_notify_inends(obj->tx_qedge, CANQUEUE_NOTIFY_ERRTX_PREP);
581 canque_free_outslot(obj->qends, obj->tx_qedge, obj->tx_slot);
585 if (chip->chipspecops->send_msg(chip, obj, &obj->tx_slot->msg)) {
587 canque_notify_inends(obj->tx_qedge, CANQUEUE_NOTIFY_ERRTX_SEND);
588 canque_free_outslot(obj->qends, obj->tx_qedge, obj->tx_slot);
598 * sja1000p_irq_handler: - interrupt service routine
599 * @irq: interrupt vector number, this value is system specific
600 * @dev_id: driver private pointer registered at time of request_irq() call.
601 * The CAN driver uses this pointer to store relationship of interrupt
602 * to chip state structure - @struct chip_t
603 * @regs: system dependent value pointing to registers stored in exception frame
605 * Interrupt handler is activated when state of CAN controller chip changes,
606 * there is message to be read or there is more space for new messages or
607 * error occurs. The receive events results in reading of the message from
608 * CAN controller chip and distribution of message through attached
610 * File: src/sja1000p.c
612 irqreturn_t sja1000p_irq_handler(int irq, void *dev_id, struct pt_regs *regs)
614 int irq_register, status, error_code;
615 struct chip_t *chip=(struct chip_t *)dev_id;
616 struct msgobj_t *obj=chip->msgobj[0];
618 irq_register=can_read_reg(chip,SJAIR);
619 // DEBUGMSG("sja1000_irq_handler: SJAIR:%02x\n",irq_register);
620 // DEBUGMSG("sja1000_irq_handler: SJASR:%02x\n",
621 // can_read_reg(chip,SJASR));
623 if ((irq_register & (IR_BEI|IR_EPI|IR_DOI|IR_EI|IR_TI|IR_RI)) == 0)
626 if(!obj->flags & OBJ_BUFFERS_ALLOCATED) {
627 CANMSG("sja1000p_irq_handler: called with device closed, irq_register 0x%02x\n", irq_register);
631 if ((irq_register & IR_RI) != 0) {
632 DEBUGMSG("sja1000_irq_handler: RI\n");
633 sja1000p_read(chip,obj);
636 if ((irq_register & IR_TI) != 0) {
637 DEBUGMSG("sja1000_irq_handler: TI\n");
639 set_bit(OBJ_TX_REQUEST,&obj->flags);
640 while(!test_and_set_bit(OBJ_TX_LOCK,&obj->flags)){
641 clear_bit(OBJ_TX_REQUEST,&obj->flags);
643 if (can_read_reg(chip, SJASR) & SR_TBS)
644 sja1000p_irq_write_handler(chip, obj);
646 clear_bit(OBJ_TX_LOCK,&obj->flags);
647 if(!test_bit(OBJ_TX_REQUEST,&obj->flags)) break;
648 DEBUGMSG("TX looping in sja1000_irq_handler\n");
651 if ((irq_register & (IR_EI|IR_BEI|IR_EPI|IR_DOI)) != 0) {
652 // Some error happened
653 status=can_read_reg(chip,SJASR);
654 error_code=can_read_reg(chip,SJAECC);
655 CANMSG("Error: status register: 0x%x irq_register: 0x%02x error: 0x%02x\n",
656 status, irq_register, error_code);
657 // FIXME: chip should be brought to usable state. Transmission cancelled if in progress.
658 // Reset flag set to 0 if chip is already off the bus. Full state report
661 if(error_code == 0xd9) {
663 /* no such device or address - no ACK received */
665 if(obj->tx_retry_cnt++>MAX_RETR) {
666 can_write_reg(chip, CMR_AT, SJACMR); // cancel any transmition
667 obj->tx_retry_cnt = 0;
670 CANMSG("bus-off, resetting sja1000p\n");
671 can_write_reg(chip, 0, SJAMOD);
675 canque_notify_inends(obj->tx_qedge, CANQUEUE_NOTIFY_ERRTX_BUS);
676 /*canque_free_outslot(obj->qends, obj->tx_qedge, obj->tx_slot);
688 * sja1000p_wakeup_tx: - wakeups TX processing
689 * @chip: pointer to chip state structure
690 * @obj: pointer to message object structure
692 * Return Value: negative value reports error.
693 * File: src/sja1000p.c
695 int sja1000p_wakeup_tx(struct chip_t *chip, struct msgobj_t *obj)
697 /* dummy lock to prevent preemption fully portable way */
698 spinlock_t dummy_lock;
700 /* preempt_disable() */
701 spin_lock_init(&dummy_lock);
702 spin_lock(&dummy_lock);
704 set_bit(OBJ_TX_REQUEST,&obj->flags);
705 while(!test_and_set_bit(OBJ_TX_LOCK,&obj->flags)){
706 clear_bit(OBJ_TX_REQUEST,&obj->flags);
708 if (can_read_reg(chip, SJASR) & SR_TBS){
710 sja1000p_irq_write_handler(chip, obj);
713 clear_bit(OBJ_TX_LOCK,&obj->flags);
714 if(!test_bit(OBJ_TX_REQUEST,&obj->flags)) break;
715 DEBUGMSG("TX looping in sja1000p_wakeup_tx\n");
718 /* preempt_enable(); */
719 spin_unlock(&dummy_lock);
723 int sja1000p_register(struct chipspecops_t *chipspecops)
725 CANMSG("initializing sja1000p chip operations\n");
726 chipspecops->chip_config=sja1000p_chip_config;
727 chipspecops->baud_rate=sja1000p_baud_rate;
728 chipspecops->standard_mask=sja1000p_standard_mask;
729 chipspecops->extended_mask=sja1000p_extended_mask;
730 chipspecops->message15_mask=sja1000p_extended_mask;
731 chipspecops->clear_objects=sja1000p_clear_objects;
732 chipspecops->config_irqs=sja1000p_config_irqs;
733 chipspecops->pre_read_config=sja1000p_pre_read_config;
734 chipspecops->pre_write_config=sja1000p_pre_write_config;
735 chipspecops->send_msg=sja1000p_send_msg;
736 chipspecops->check_tx_stat=sja1000p_check_tx_stat;
737 chipspecops->wakeup_tx=sja1000p_wakeup_tx;
738 chipspecops->remote_request=sja1000p_remote_request;
739 chipspecops->enable_configuration=sja1000p_enable_configuration;
740 chipspecops->disable_configuration=sja1000p_disable_configuration;
741 chipspecops->set_btregs=sja1000p_set_btregs;
742 chipspecops->start_chip=sja1000p_start_chip;
743 chipspecops->stop_chip=sja1000p_stop_chip;
744 chipspecops->irq_handler=sja1000p_irq_handler;