Greg Steiert / maxim_dev

Maxim mbed development library

Dependents:   sensomed

hal/can_api.h@0:0e018d759a2a, 2016-11-08 (annotated)

Committer:
switches
Date:
Tue Nov 08 18:27:11 2016 +0000
Revision:
0:0e018d759a2a
Initial commit

Who changed what in which revision?

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