Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

hal/can_api.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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