Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

hal/can_api.h@0:5b88d5760320, 2019-12-17 (annotated)

Committer:
kenjiArai
Date:
Tue Dec 17 23:23:45 2019 +0000
Revision:
0:5b88d5760320
Child:
1:9db0e321a9f4
mbed-os5 only for TYBLE16

Who changed what in which revision?

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