Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

hal/buffer.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1
elessair 0:f269e3021894 2 /** \addtogroup hal */
elessair 0:f269e3021894 3 /** @{*/
elessair 0:f269e3021894 4 /* mbed Microcontroller Library
elessair 0:f269e3021894 5 * Copyright (c) 2014-2015 ARM Limited
elessair 0:f269e3021894 6 *
elessair 0:f269e3021894 7 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 8 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 9 * You may obtain a copy of the License at
elessair 0:f269e3021894 10 *
elessair 0:f269e3021894 11 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 12 *
elessair 0:f269e3021894 13 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 14 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 16 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 17 * limitations under the License.
elessair 0:f269e3021894 18 */
elessair 0:f269e3021894 19 #ifndef MBED_BUFFER_H
elessair 0:f269e3021894 20 #define MBED_BUFFER_H
elessair 0:f269e3021894 21
elessair 0:f269e3021894 22 #include <stddef.h>
elessair 0:f269e3021894 23
elessair 0:f269e3021894 24 /** Generic buffer structure
elessair 0:f269e3021894 25 */
elessair 0:f269e3021894 26 typedef struct buffer_s {
elessair 0:f269e3021894 27 void *buffer; /**< the pointer to a buffer */
elessair 0:f269e3021894 28 size_t length; /**< the buffer length */
elessair 0:f269e3021894 29 size_t pos; /**< actual buffer position */
elessair 0:f269e3021894 30 uint8_t width; /**< The buffer unit width (8, 16, 32, 64), used for proper *buffer casting */
elessair 0:f269e3021894 31 } buffer_t;
elessair 0:f269e3021894 32
elessair 0:f269e3021894 33 #endif
elessair 0:f269e3021894 34
elessair 0:f269e3021894 35 /** @}*/