msm: smem: add smem_get_free_space()

The smem_get_free_space() API is a private helper function to optimize the
SMD client's table scanning usecase.

Change-Id: I00b12bf3b667001f973fd5126278536b47e052f4
Signed-off-by: Jeffrey Hugo <jhugo@codeaurora.org>