From patchwork Thu Aug 28 20:53:42 2014 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Mike Holmes X-Patchwork-Id: 36263 Return-Path: X-Original-To: linaro@patches.linaro.org Delivered-To: linaro@patches.linaro.org Received: from mail-ob0-f200.google.com (mail-ob0-f200.google.com [209.85.214.200]) by ip-10-151-82-157.ec2.internal (Postfix) with ESMTPS id C736F20551 for ; Thu, 28 Aug 2014 20:54:09 +0000 (UTC) Received: by mail-ob0-f200.google.com with SMTP id va2sf10447558obc.3 for ; Thu, 28 Aug 2014 13:54:09 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:delivered-to:from:to:date:message-id:subject :precedence:list-id:list-unsubscribe:list-archive:list-post :list-help:list-subscribe:mime-version:errors-to:sender :x-original-sender:x-original-authentication-results:mailing-list :content-type:content-transfer-encoding; bh=8KhWftZq5ISq9f+wEPGMRwDekVqYUpcO51gJ4I/ldYQ=; b=PMjTpNT+dL5xRrkVEGw7CnHyLzIliH1A5YVBWnHN0xNR+DZ3uEJ6RTrwMQCmOgp5lm kDcaZ0t+T311zENFAybd7ohtWsgKxN0pVpsegZSeznMYiMHeFGDBW75DgWHheYEkS96c 4rMNKrKSJbhDEkr0r9HGA3ELbdn8IXJYKFHr66eZSoi+P/Kl/XA012M2dtw2/y7d6COn qfUd326b1aQm28XiRz1Oy8m8DauoFnjTDpvPYr/Tuj7Tm5ExVwPET2f7K5oOPksqazcx 8L+pL85+e6Fkf0De3sPu9ow2yTe0YG9OGPNQr9suaYTtafPIpKSfqUFq5LVTikU6UUMd ntTQ== X-Gm-Message-State: ALoCoQklMHWlKT2/cAT7cXt4gXDpYItr4xF7I1um0i8b1GAh/w0c6Pe3/H4U/+Uy06FoPtUqHzNB X-Received: by 10.182.142.5 with SMTP id rs5mr3187081obb.15.1409259249403; Thu, 28 Aug 2014 13:54:09 -0700 (PDT) X-BeenThere: patchwork-forward@linaro.org Received: by 10.140.97.100 with SMTP id l91ls720176qge.69.gmail; Thu, 28 Aug 2014 13:54:09 -0700 (PDT) X-Received: by 10.53.10.65 with SMTP id dy1mr3233191vdd.92.1409259249308; Thu, 28 Aug 2014 13:54:09 -0700 (PDT) Received: from mail-vc0-f176.google.com (mail-vc0-f176.google.com [209.85.220.176]) by mx.google.com with ESMTPS id v8si5167935vcx.74.2014.08.28.13.54.09 for (version=TLSv1 cipher=ECDHE-RSA-RC4-SHA bits=128/128); Thu, 28 Aug 2014 13:54:09 -0700 (PDT) Received-SPF: pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.176 as permitted sender) client-ip=209.85.220.176; Received: by mail-vc0-f176.google.com with SMTP id ik5so1515448vcb.7 for ; Thu, 28 Aug 2014 13:54:09 -0700 (PDT) X-Received: by 10.52.3.40 with SMTP id 8mr5404315vdz.24.1409259249097; Thu, 28 Aug 2014 13:54:09 -0700 (PDT) X-Forwarded-To: patchwork-forward@linaro.org X-Forwarded-For: patch@linaro.org patchwork-forward@linaro.org Delivered-To: patch@linaro.org Received: by 10.221.45.67 with SMTP id uj3csp295099vcb; Thu, 28 Aug 2014 13:54:08 -0700 (PDT) X-Received: by 10.140.43.245 with SMTP id e108mr10204525qga.76.1409259247738; Thu, 28 Aug 2014 13:54:07 -0700 (PDT) Received: from ip-10-141-164-156.ec2.internal (lists.linaro.org. [54.225.227.206]) by mx.google.com with ESMTPS id k7si7380423qaf.51.2014.08.28.13.54.07 for (version=TLSv1 cipher=RC4-SHA bits=128/128); Thu, 28 Aug 2014 13:54:07 -0700 (PDT) Received-SPF: none (google.com: lng-odp-bounces@lists.linaro.org does not designate permitted sender hosts) client-ip=54.225.227.206; Received: from localhost ([127.0.0.1] helo=ip-10-141-164-156.ec2.internal) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XN6hp-00012l-8C; Thu, 28 Aug 2014 20:54:05 +0000 Received: from mail-qg0-f41.google.com ([209.85.192.41]) by ip-10-141-164-156.ec2.internal with esmtp (Exim 4.76) (envelope-from ) id 1XN6hj-00012g-9a for lng-odp@lists.linaro.org; Thu, 28 Aug 2014 20:53:59 +0000 Received: by mail-qg0-f41.google.com with SMTP id i50so1371036qgf.0 for ; Thu, 28 Aug 2014 13:53:54 -0700 (PDT) X-Received: by 10.229.136.133 with SMTP id r5mr10670147qct.31.1409259234000; Thu, 28 Aug 2014 13:53:54 -0700 (PDT) Received: from fedora1.holmesfamily.ws (c-98-221-136-245.hsd1.nj.comcast.net. [98.221.136.245]) by mx.google.com with ESMTPSA id l10sm15005825qai.4.2014.08.28.13.53.53 for (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 28 Aug 2014 13:53:53 -0700 (PDT) From: Mike Holmes To: lng-odp@lists.linaro.org Date: Thu, 28 Aug 2014 16:53:42 -0400 Message-Id: <1409259222-957-1-git-send-email-mike.holmes@linaro.org> X-Mailer: git-send-email 1.9.1 X-Topics: patch Subject: [lng-odp] [PATCH] odp_shared_memory.h: Document odp_shm_reserve X-BeenThere: lng-odp@lists.linaro.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: , List-Help: , List-Subscribe: , MIME-Version: 1.0 Errors-To: lng-odp-bounces@lists.linaro.org Sender: lng-odp-bounces@lists.linaro.org X-Removed-Original-Auth: Dkim didn't pass. X-Original-Sender: mike.holmes@linaro.org X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of patch+caf_=patchwork-forward=linaro.org@linaro.org designates 209.85.220.176 as permitted sender) smtp.mail=patch+caf_=patchwork-forward=linaro.org@linaro.org Mailing-list: list patchwork-forward@linaro.org; contact patchwork-forward+owners@linaro.org X-Google-Group-Id: 836684582541 Signed-off-by: Mike Holmes --- platform/linux-generic/include/api/odp_shared_memory.h | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/platform/linux-generic/include/api/odp_shared_memory.h b/platform/linux-generic/include/api/odp_shared_memory.h index 8ac8847..d75b179 100644 --- a/platform/linux-generic/include/api/odp_shared_memory.h +++ b/platform/linux-generic/include/api/odp_shared_memory.h @@ -21,7 +21,7 @@ extern "C" { #include -/** Maximum shared memory block name lenght in chars */ +/** Maximum shared memory block name length in chars */ #define ODP_SHM_NAME_LEN 32 @@ -33,6 +33,9 @@ extern "C" { * @param align Block alignment in bytes * * @return Pointer to the reserved block, or NULL + * + * @note The same block name cannot be reused. + * @note There is no way to unreserve a named block */ void *odp_shm_reserve(const char *name, uint64_t size, uint64_t align);