Gan likun / mbed1-dev

001

hal/can_api.h@0:13413ea9a877, 2022-06-12 (annotated)

Committer:
ganlikun
Date:
Sun Jun 12 14:02:44 2022 +0000
Revision:
0:13413ea9a877
00

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ganlikun 0:13413ea9a877 1
ganlikun 0:13413ea9a877 2 /** \addtogroup hal */
ganlikun 0:13413ea9a877 3 /** @{*/
ganlikun 0:13413ea9a877 4 /* mbed Microcontroller Library
ganlikun 0:13413ea9a877 5 * Copyright (c) 2006-2016 ARM Limited
ganlikun 0:13413ea9a877 6 *
ganlikun 0:13413ea9a877 7 * Licensed under the Apache License, Version 2.0 (the "License");
ganlikun 0:13413ea9a877 8 * you may not use this file except in compliance with the License.
ganlikun 0:13413ea9a877 9 * You may obtain a copy of the License at
ganlikun 0:13413ea9a877 10 *
ganlikun 0:13413ea9a877 11 * http://www.apache.org/licenses/LICENSE-2.0
ganlikun 0:13413ea9a877 12 *
ganlikun 0:13413ea9a877 13 * Unless required by applicable law or agreed to in writing, software
ganlikun 0:13413ea9a877 14 * distributed under the License is distributed on an "AS IS" BASIS,
ganlikun 0:13413ea9a877 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
ganlikun 0:13413ea9a877 16 * See the License for the specific language governing permissions and
ganlikun 0:13413ea9a877 17 * limitations under the License.
ganlikun 0:13413ea9a877 18 */
ganlikun 0:13413ea9a877 19 #ifndef MBED_CAN_API_H
ganlikun 0:13413ea9a877 20 #define MBED_CAN_API_H
ganlikun 0:13413ea9a877 21
ganlikun 0:13413ea9a877 22 #include "device.h"
ganlikun 0:13413ea9a877 23
ganlikun 0:13413ea9a877 24 #if DEVICE_CAN
ganlikun 0:13413ea9a877 25
ganlikun 0:13413ea9a877 26 #include "PinNames.h"
ganlikun 0:13413ea9a877 27 #include "PeripheralNames.h"
ganlikun 0:13413ea9a877 28 #include "hal/can_helper.h"
ganlikun 0:13413ea9a877 29
ganlikun 0:13413ea9a877 30 #ifdef __cplusplus
ganlikun 0:13413ea9a877 31 extern "C" {
ganlikun 0:13413ea9a877 32 #endif
ganlikun 0:13413ea9a877 33
ganlikun 0:13413ea9a877 34 typedef enum {
ganlikun 0:13413ea9a877 35 IRQ_RX,
ganlikun 0:13413ea9a877 36 IRQ_TX,
ganlikun 0:13413ea9a877 37 IRQ_ERROR,
ganlikun 0:13413ea9a877 38 IRQ_OVERRUN,
ganlikun 0:13413ea9a877 39 IRQ_WAKEUP,
ganlikun 0:13413ea9a877 40 IRQ_PASSIVE,
ganlikun 0:13413ea9a877 41 IRQ_ARB,
ganlikun 0:13413ea9a877 42 IRQ_BUS,
ganlikun 0:13413ea9a877 43 IRQ_READY
ganlikun 0:13413ea9a877 44 } CanIrqType;
ganlikun 0:13413ea9a877 45
ganlikun 0:13413ea9a877 46
ganlikun 0:13413ea9a877 47 typedef enum {
ganlikun 0:13413ea9a877 48 MODE_RESET,
ganlikun 0:13413ea9a877 49 MODE_NORMAL,
ganlikun 0:13413ea9a877 50 MODE_SILENT,
ganlikun 0:13413ea9a877 51 MODE_TEST_LOCAL,
ganlikun 0:13413ea9a877 52 MODE_TEST_GLOBAL,
ganlikun 0:13413ea9a877 53 MODE_TEST_SILENT
ganlikun 0:13413ea9a877 54 } CanMode;
ganlikun 0:13413ea9a877 55
ganlikun 0:13413ea9a877 56 typedef void (*can_irq_handler)(uint32_t id, CanIrqType type);
ganlikun 0:13413ea9a877 57
ganlikun 0:13413ea9a877 58 typedef struct can_s can_t;
ganlikun 0:13413ea9a877 59
ganlikun 0:13413ea9a877 60 void can_init (can_t *obj, PinName rd, PinName td);
ganlikun 0:13413ea9a877 61 void can_init_freq (can_t *obj, PinName rd, PinName td, int hz);
ganlikun 0:13413ea9a877 62 void can_free (can_t *obj);
ganlikun 0:13413ea9a877 63 int can_frequency (can_t *obj, int hz);
ganlikun 0:13413ea9a877 64
ganlikun 0:13413ea9a877 65 void can_irq_init (can_t *obj, can_irq_handler handler, uint32_t id);
ganlikun 0:13413ea9a877 66 void can_irq_free (can_t *obj);
ganlikun 0:13413ea9a877 67 void can_irq_set (can_t *obj, CanIrqType irq, uint32_t enable);
ganlikun 0:13413ea9a877 68
ganlikun 0:13413ea9a877 69 int can_write (can_t *obj, CAN_Message, int cc);
ganlikun 0:13413ea9a877 70 int can_read (can_t *obj, CAN_Message *msg, int handle);
ganlikun 0:13413ea9a877 71 int can_mode (can_t *obj, CanMode mode);
ganlikun 0:13413ea9a877 72 int can_filter(can_t *obj, uint32_t id, uint32_t mask, CANFormat format, int32_t handle);
ganlikun 0:13413ea9a877 73 void can_reset (can_t *obj);
ganlikun 0:13413ea9a877 74 unsigned char can_rderror (can_t *obj);
ganlikun 0:13413ea9a877 75 unsigned char can_tderror (can_t *obj);
ganlikun 0:13413ea9a877 76 void can_monitor (can_t *obj, int silent);
ganlikun 0:13413ea9a877 77
ganlikun 0:13413ea9a877 78 #ifdef __cplusplus
ganlikun 0:13413ea9a877 79 };
ganlikun 0:13413ea9a877 80 #endif
ganlikun 0:13413ea9a877 81
ganlikun 0:13413ea9a877 82 #endif // MBED_CAN_API_H
ganlikun 0:13413ea9a877 83
ganlikun 0:13413ea9a877 84 #endif
ganlikun 0:13413ea9a877 85
ganlikun 0:13413ea9a877 86 /** @}*/
ganlikun 0:13413ea9a877 87