Sergey Solodunov / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by mbed official

targets/hal/TARGET_Atmel/TARGET_SAM_CortexM0P/pinmap_function.h@15:a81a8d6c1dfe, 2015-11-04 (annotated)

Committer:
mbed_official
Date:
Wed Nov 04 16:30:11 2015 +0000
Revision:
15:a81a8d6c1dfe
Synchronized with git revision 46af745ef4405614c3fa49abbd9a706a362ea514



Full URL: https://github.com/mbedmicro/mbed/commit/46af745ef4405614c3fa49abbd9a706a362ea514/



Renamed TARGET_SAM_CortexM0+ to TARGET_SAM_CortexM0P for compatiblity with online compiler

Who changed what in which revision?

UserRevisionLine numberNew contents of line
mbed_official 15:a81a8d6c1dfe 1 /* mbed Microcontroller Library
mbed_official 15:a81a8d6c1dfe 2 * Copyright (c) 2006-2015 ARM Limited
mbed_official 15:a81a8d6c1dfe 3 *
mbed_official 15:a81a8d6c1dfe 4 * Licensed under the Apache License, Version 2.0 (the "License");
mbed_official 15:a81a8d6c1dfe 5 * you may not use this file except in compliance with the License.
mbed_official 15:a81a8d6c1dfe 6 * You may obtain a copy of the License at
mbed_official 15:a81a8d6c1dfe 7 *
mbed_official 15:a81a8d6c1dfe 8 * http://www.apache.org/licenses/LICENSE-2.0
mbed_official 15:a81a8d6c1dfe 9 *
mbed_official 15:a81a8d6c1dfe 10 * Unless required by applicable law or agreed to in writing, software
mbed_official 15:a81a8d6c1dfe 11 * distributed under the License is distributed on an "AS IS" BASIS,
mbed_official 15:a81a8d6c1dfe 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
mbed_official 15:a81a8d6c1dfe 13 * See the License for the specific language governing permissions and
mbed_official 15:a81a8d6c1dfe 14 * limitations under the License.
mbed_official 15:a81a8d6c1dfe 15 */
mbed_official 15:a81a8d6c1dfe 16 #ifndef PINMAP_FUNCTION_H
mbed_official 15:a81a8d6c1dfe 17 #define PINMAP_FUNCTION_H
mbed_official 15:a81a8d6c1dfe 18
mbed_official 15:a81a8d6c1dfe 19 #include <compiler.h>
mbed_official 15:a81a8d6c1dfe 20 #include "cmsis.h"
mbed_official 15:a81a8d6c1dfe 21 #include "PinNames.h"
mbed_official 15:a81a8d6c1dfe 22 #include "pinmux.h"
mbed_official 15:a81a8d6c1dfe 23 #include "pinmap.h"
mbed_official 15:a81a8d6c1dfe 24
mbed_official 15:a81a8d6c1dfe 25 #include "PeripheralPins.h"
mbed_official 15:a81a8d6c1dfe 26
mbed_official 15:a81a8d6c1dfe 27 #ifdef __cplusplus
mbed_official 15:a81a8d6c1dfe 28 extern "C" {
mbed_official 15:a81a8d6c1dfe 29 #endif
mbed_official 15:a81a8d6c1dfe 30
mbed_official 15:a81a8d6c1dfe 31 enum sercom_pad_selection {
mbed_official 15:a81a8d6c1dfe 32 SERCOM_USE_DEFAULT_PAD,
mbed_official 15:a81a8d6c1dfe 33 SERCOM_USE_EXTENDED_PAD,
mbed_official 15:a81a8d6c1dfe 34 };
mbed_official 15:a81a8d6c1dfe 35
mbed_official 15:a81a8d6c1dfe 36 /** Find the SERCOM peripheral of given pin
mbed_official 15:a81a8d6c1dfe 37 *
mbed_official 15:a81a8d6c1dfe 38 * Find and return the SERCOM peripheral of input pin, either from default pas, or from extended pads
mbed_official 15:a81a8d6c1dfe 39 * @param[in] pin1 First pin
mbed_official 15:a81a8d6c1dfe 40 * @param[in] pad_select Second pin
mbed_official 15:a81a8d6c1dfe 41 * @return SERCOM peripheral if found, else, NC
mbed_official 15:a81a8d6c1dfe 42 */
mbed_official 15:a81a8d6c1dfe 43 uint32_t pinmap_find_peripheral_from_pad(PinName pin, enum sercom_pad_selection pad_select);
mbed_official 15:a81a8d6c1dfe 44
mbed_official 15:a81a8d6c1dfe 45 /** Find the common SERCOM shared by two pins
mbed_official 15:a81a8d6c1dfe 46 *
mbed_official 15:a81a8d6c1dfe 47 * Finds the common SERCOM index of two input pins.
mbed_official 15:a81a8d6c1dfe 48 * If swapping the input argument gives different result, it means, two SERCOMs share both pins
mbed_official 15:a81a8d6c1dfe 49 * @param[in] pin1 First pin
mbed_official 15:a81a8d6c1dfe 50 * @param[in] pin2 Second pin
mbed_official 15:a81a8d6c1dfe 51 * @return SERCOM index if found, else, NC
mbed_official 15:a81a8d6c1dfe 52 */
mbed_official 15:a81a8d6c1dfe 53 uint32_t pinmap_merge_sercom(PinName pin1, PinName pin2);
mbed_official 15:a81a8d6c1dfe 54
mbed_official 15:a81a8d6c1dfe 55 /** Find the common SERCOM shared by four pins
mbed_official 15:a81a8d6c1dfe 56 *
mbed_official 15:a81a8d6c1dfe 57 * Finds the common SERCOM index shared by four input pins.
mbed_official 15:a81a8d6c1dfe 58 * If reversing the input argument order gives different result, it means, two SERCOMs share the pins
mbed_official 15:a81a8d6c1dfe 59 * @param[in] pin1 First pin
mbed_official 15:a81a8d6c1dfe 60 * @param[in] pin2 Second pin
mbed_official 15:a81a8d6c1dfe 61 * @param[in] pin3 Third pin
mbed_official 15:a81a8d6c1dfe 62 * @param[in] pin4 Fourth pin
mbed_official 15:a81a8d6c1dfe 63 * @return SERCOM index if found, else, NC
mbed_official 15:a81a8d6c1dfe 64 */
mbed_official 15:a81a8d6c1dfe 65 uint32_t pinmap_find_sercom(PinName pin1, PinName pin2, PinName pin3, PinName pin4);
mbed_official 15:a81a8d6c1dfe 66
mbed_official 15:a81a8d6c1dfe 67 /** Find the MUX function of input pin specific to given SERCOM index
mbed_official 15:a81a8d6c1dfe 68 *
mbed_official 15:a81a8d6c1dfe 69 * @param[in] pin Pin whose function is to be found out
mbed_official 15:a81a8d6c1dfe 70 * @param[in] sercom_index SERCOM index
mbed_official 15:a81a8d6c1dfe 71 * @return MUX function if found, else, NC
mbed_official 15:a81a8d6c1dfe 72 */
mbed_official 15:a81a8d6c1dfe 73 uint32_t pinmap_function_sercom(PinName pin, uint32_t sercom_index);
mbed_official 15:a81a8d6c1dfe 74
mbed_official 15:a81a8d6c1dfe 75 /** Find the MUX pad of input pin specific to given SERCOM index
mbed_official 15:a81a8d6c1dfe 76 *
mbed_official 15:a81a8d6c1dfe 77 * @param[in] pin Pin whose function is to be found out
mbed_official 15:a81a8d6c1dfe 78 * @param[in] sercom_index SERCOM index
mbed_official 15:a81a8d6c1dfe 79 * @return MUX pad if found, else, NC
mbed_official 15:a81a8d6c1dfe 80 */
mbed_official 15:a81a8d6c1dfe 81 uint32_t pinmap_pad_sercom(PinName pin, uint32_t sercom_index);
mbed_official 15:a81a8d6c1dfe 82
mbed_official 15:a81a8d6c1dfe 83 /** Find the MUX function of input pin specific to given SERCOM index
mbed_official 15:a81a8d6c1dfe 84 *
mbed_official 15:a81a8d6c1dfe 85 * @param[in] pin unused
mbed_official 15:a81a8d6c1dfe 86 * @param[in] sercom_index SERCOM index
mbed_official 15:a81a8d6c1dfe 87 * @return base address to SERCOM if found, else NC
mbed_official 15:a81a8d6c1dfe 88 */
mbed_official 15:a81a8d6c1dfe 89 uint32_t pinmap_peripheral_sercom(PinName pin, uint32_t sercom_index);
mbed_official 15:a81a8d6c1dfe 90
mbed_official 15:a81a8d6c1dfe 91 /** Find the channel index of a pin specific to a PWM instance
mbed_official 15:a81a8d6c1dfe 92 *
mbed_official 15:a81a8d6c1dfe 93 * @param[in] pin pin name
mbed_official 15:a81a8d6c1dfe 94 * @param[in] pwm pwm peripheral (unused now)
mbed_official 15:a81a8d6c1dfe 95 * @return Channel index of the specified pin
mbed_official 15:a81a8d6c1dfe 96 */
mbed_official 15:a81a8d6c1dfe 97 uint32_t pinmap_channel_pwm(PinName pin, PWMName pwm);
mbed_official 15:a81a8d6c1dfe 98
mbed_official 15:a81a8d6c1dfe 99 #ifdef __cplusplus
mbed_official 15:a81a8d6c1dfe 100 }
mbed_official 15:a81a8d6c1dfe 101 #endif
mbed_official 15:a81a8d6c1dfe 102
mbed_official 15:a81a8d6c1dfe 103 #endif /* PINMAP_FUNCTION_H */