Marco Mayer / Mbed OS Queue

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.

mbed-os/features/netsocket/emac_stack_mem.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
demayer 0:6bf0743ece18 1 /* mbed Microcontroller Library
demayer 0:6bf0743ece18 2 * Copyright (c) 2016 ARM Limited
demayer 0:6bf0743ece18 3 *
demayer 0:6bf0743ece18 4 * Licensed under the Apache License, Version 2.0 (the "License");
demayer 0:6bf0743ece18 5 * you may not use this file except in compliance with the License.
demayer 0:6bf0743ece18 6 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 7 *
demayer 0:6bf0743ece18 8 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 9 *
demayer 0:6bf0743ece18 10 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 11 * distributed under the License is distributed on an "AS IS" BASIS,
demayer 0:6bf0743ece18 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 13 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 14 * limitations under the License.
demayer 0:6bf0743ece18 15 */
demayer 0:6bf0743ece18 16 #ifndef MBED_EMAC_STACK_MEM_H
demayer 0:6bf0743ece18 17 #define MBED_EMAC_STACK_MEM_H
demayer 0:6bf0743ece18 18
demayer 0:6bf0743ece18 19 #if DEVICE_EMAC
demayer 0:6bf0743ece18 20
demayer 0:6bf0743ece18 21 #include <stdint.h>
demayer 0:6bf0743ece18 22
demayer 0:6bf0743ece18 23 /**
demayer 0:6bf0743ece18 24 * Stack memory module
demayer 0:6bf0743ece18 25 *
demayer 0:6bf0743ece18 26 * This interface provides abstraction for memory modules used in different IP stacks (often to accommodate zero copy).
demayer 0:6bf0743ece18 27 * Emac interface may be required to accept output packets and provide received data using this stack specific API.
demayer 0:6bf0743ece18 28 * This header should be implemented for each IP stack, so that we keep emacs module independent.
demayer 0:6bf0743ece18 29 */
demayer 0:6bf0743ece18 30 typedef void emac_stack_mem_t;
demayer 0:6bf0743ece18 31 typedef void emac_stack_mem_chain_t;
demayer 0:6bf0743ece18 32 typedef void emac_stack_t;
demayer 0:6bf0743ece18 33
demayer 0:6bf0743ece18 34 /**
demayer 0:6bf0743ece18 35 * Allocates stack memory
demayer 0:6bf0743ece18 36 *
demayer 0:6bf0743ece18 37 * @param stack Emac stack context
demayer 0:6bf0743ece18 38 * @param size Size of memory to allocate
demayer 0:6bf0743ece18 39 * @param align Memory alignment requirements
demayer 0:6bf0743ece18 40 * @return Allocated memory struct, or NULL in case of error
demayer 0:6bf0743ece18 41 */
demayer 0:6bf0743ece18 42 emac_stack_mem_t *emac_stack_mem_alloc(emac_stack_t* stack, uint32_t size, uint32_t align);
demayer 0:6bf0743ece18 43
demayer 0:6bf0743ece18 44 /**
demayer 0:6bf0743ece18 45 * Free memory allocated using @a stack_mem_alloc
demayer 0:6bf0743ece18 46 *
demayer 0:6bf0743ece18 47 * @param stack Emac stack context
demayer 0:6bf0743ece18 48 * @param mem Memory to be freed
demayer 0:6bf0743ece18 49 */
demayer 0:6bf0743ece18 50 void emac_stack_mem_free(emac_stack_t* stack, emac_stack_mem_t *mem);
demayer 0:6bf0743ece18 51
demayer 0:6bf0743ece18 52 /**
demayer 0:6bf0743ece18 53 * Copy memory
demayer 0:6bf0743ece18 54 *
demayer 0:6bf0743ece18 55 * @param stack Emac stack context
demayer 0:6bf0743ece18 56 * @param to Memory to copy to
demayer 0:6bf0743ece18 57 * @param from Memory to copy from
demayer 0:6bf0743ece18 58 */
demayer 0:6bf0743ece18 59 void emac_stack_mem_copy(emac_stack_t* stack, emac_stack_mem_t *to, emac_stack_mem_t *from);
demayer 0:6bf0743ece18 60
demayer 0:6bf0743ece18 61 /**
demayer 0:6bf0743ece18 62 * Return pointer to the payload
demayer 0:6bf0743ece18 63 *
demayer 0:6bf0743ece18 64 * @param stack Emac stack context
demayer 0:6bf0743ece18 65 * @param mem Memory structure
demayer 0:6bf0743ece18 66 * @return Pointer to the payload
demayer 0:6bf0743ece18 67 */
demayer 0:6bf0743ece18 68 void *emac_stack_mem_ptr(emac_stack_t* stack, emac_stack_mem_t *mem);
demayer 0:6bf0743ece18 69
demayer 0:6bf0743ece18 70 /**
demayer 0:6bf0743ece18 71 * Return actual payload size
demayer 0:6bf0743ece18 72 *
demayer 0:6bf0743ece18 73 * @param stack Emac stack context
demayer 0:6bf0743ece18 74 * @param mem Memory structure
demayer 0:6bf0743ece18 75 * @return Size in bytes
demayer 0:6bf0743ece18 76 */
demayer 0:6bf0743ece18 77 uint32_t emac_stack_mem_len(emac_stack_t* stack, emac_stack_mem_t *mem);
demayer 0:6bf0743ece18 78
demayer 0:6bf0743ece18 79 /**
demayer 0:6bf0743ece18 80 * Sets the actual payload size (the allocated payload size will not change)
demayer 0:6bf0743ece18 81 *
demayer 0:6bf0743ece18 82 * @param stack Emac stack context
demayer 0:6bf0743ece18 83 * @param mem Memory structure
demayer 0:6bf0743ece18 84 * @param len Actual payload size
demayer 0:6bf0743ece18 85 */
demayer 0:6bf0743ece18 86 void emac_stack_mem_set_len(emac_stack_t* stack, emac_stack_mem_t *mem, uint32_t len);
demayer 0:6bf0743ece18 87
demayer 0:6bf0743ece18 88 /**
demayer 0:6bf0743ece18 89 * Returns first memory structure from the list and move the head to point to the next node
demayer 0:6bf0743ece18 90 *
demayer 0:6bf0743ece18 91 * @param stack Emac stack context
demayer 0:6bf0743ece18 92 * @param chain Pointer to the list
demayer 0:6bf0743ece18 93 * @return First memory structure from the list
demayer 0:6bf0743ece18 94 */
demayer 0:6bf0743ece18 95 emac_stack_mem_t *emac_stack_mem_chain_dequeue(emac_stack_t* stack, emac_stack_mem_chain_t **chain);
demayer 0:6bf0743ece18 96
demayer 0:6bf0743ece18 97 /**
demayer 0:6bf0743ece18 98 * Return total length of the memory chain
demayer 0:6bf0743ece18 99 *
demayer 0:6bf0743ece18 100 * @param stack Emac stack context
demayer 0:6bf0743ece18 101 * @param chain Memory chain
demayer 0:6bf0743ece18 102 * @return Chain length
demayer 0:6bf0743ece18 103 */
demayer 0:6bf0743ece18 104 uint32_t emac_stack_mem_chain_len(emac_stack_t* stack, emac_stack_mem_chain_t *chain);
demayer 0:6bf0743ece18 105
demayer 0:6bf0743ece18 106 /**
demayer 0:6bf0743ece18 107 * Increases the reference counter for the memory
demayer 0:6bf0743ece18 108 *
demayer 0:6bf0743ece18 109 * @param stack Emac stack context
demayer 0:6bf0743ece18 110 * @param mem Memory structure
demayer 0:6bf0743ece18 111 */
demayer 0:6bf0743ece18 112 void emac_stack_mem_ref(emac_stack_t* stack, emac_stack_mem_t *mem);
demayer 0:6bf0743ece18 113
demayer 0:6bf0743ece18 114 #endif /* DEVICE_EMAC */
demayer 0:6bf0743ece18 115
demayer 0:6bf0743ece18 116 #endif /* EMAC_MBED_STACK_MEM_h */