1/* 2 * Copyright (C) 2008 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17#ifndef bbf_BIT_PARAM_EM_H 18#define bbf_BIT_PARAM_EM_H 19 20/* ---- includes ----------------------------------------------------------- */ 21 22#include "b_BasicEm/Context.h" 23#include "b_BasicEm/Basic.h" 24 25/* ---- related objects --------------------------------------------------- */ 26 27/* ---- typedefs ----------------------------------------------------------- */ 28 29/* ---- constants ---------------------------------------------------------- */ 30 31/* ---- object definition -------------------------------------------------- */ 32 33/** parameters for bit generation. */ 34struct bbf_BitParam 35{ 36 /* ---- private data --------------------------------------------------- */ 37 38 /* ---- public data ---------------------------------------------------- */ 39 40 /** outer radius of filter block */ 41 uint32 outerRadiusE; 42 43 /** inner radius of filter block */ 44 uint32 innerRadiusE; 45 46}; 47 48/* ---- associated objects ------------------------------------------------- */ 49 50/* ---- external functions ------------------------------------------------- */ 51 52/* ---- \ghd{ constructor/destructor } ------------------------------------- */ 53 54/** initializes bbf_BitParam */ 55void bbf_BitParam_init( struct bbs_Context* cpA, 56 struct bbf_BitParam* ptrA ); 57 58/** resets bbf_BitParam */ 59void bbf_BitParam_exit( struct bbs_Context* cpA, 60 struct bbf_BitParam* ptrA ); 61 62/* ---- \ghd{ operators } -------------------------------------------------- */ 63 64/** copy operator */ 65void bbf_BitParam_copy( struct bbs_Context* cpA, 66 struct bbf_BitParam* ptrA, 67 const struct bbf_BitParam* srcPtrA ); 68 69/** equal operator */ 70flag bbf_BitParam_equal( struct bbs_Context* cpA, 71 const struct bbf_BitParam* ptrA, 72 const struct bbf_BitParam* srcPtrA ); 73 74/* ---- \ghd{ query functions } -------------------------------------------- */ 75 76/* ---- \ghd{ modify functions } ------------------------------------------- */ 77 78/* ---- \ghd{ memory I/O } ------------------------------------------------- */ 79 80/** word size (16-bit) object needs when written to memory */ 81uint32 bbf_BitParam_memSize( struct bbs_Context* cpA, 82 const struct bbf_BitParam* ptrA ); 83 84/** writes object to memory; returns number of words (16-bit) written */ 85uint32 bbf_BitParam_memWrite( struct bbs_Context* cpA, 86 const struct bbf_BitParam* ptrA, uint16* memPtrA ); 87 88/** reads object from memory; returns number of words (16-bit) read */ 89uint32 bbf_BitParam_memRead( struct bbs_Context* cpA, 90 struct bbf_BitParam* ptrA, 91 const uint16* memPtrA ); 92 93/* ---- \ghd{ exec functions } --------------------------------------------- */ 94 95#endif /* bbf_BIT_PARAM_EM_H */ 96 97