Takaaki Numai / mbed-dev

inport from local

Dependents:   Hobbyking_Cheetah_0511

hal/can_api.h@0:85b3fd62ea1a, 2020-03-16 (annotated)

Committer:
NYX
Date:
Mon Mar 16 06:35:48 2020 +0000
Revision:
0:85b3fd62ea1a
reinport to mbed;

Who changed what in which revision?

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