| Message ID | 1413794777-32220-3-git-send-email-boris.brezillon@free-electrons.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On Mon, Oct 20, 2014 at 10:46:15AM +0200, Boris Brezillon wrote: > Add a new function to move bits (not bytes) from a memory region to > another one. > This function is similar to memmove except it acts at bit level. > This function is needed to implement GPMI raw access functions, given the > fact that ECC engine does not pad ECC bits to the next byte boundary. > > Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com> > --- > drivers/mtd/nand/gpmi-nand/gpmi-lib.c | 129 +++++++++++++++++++++++++++++++++ > drivers/mtd/nand/gpmi-nand/gpmi-nand.h | 4 + > 2 files changed, 133 insertions(+) > > diff --git a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > index 87e658c..5d4f140 100644 > --- a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > +++ b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > @@ -1353,3 +1353,132 @@ int gpmi_read_page(struct gpmi_nand_data *this, > set_dma_type(this, DMA_FOR_READ_ECC_PAGE); > return start_dma_with_bch_irq(this, desc); > } > + > +void gpmi_move_bits(u8 *dst, size_t dst_bit_off, > + const u8 *src, size_t src_bit_off, > + size_t nbits) Two things: 1) Yikes! This function is a little hairy. 2) This function really deserves a full comment header (kerneldoc?); it needs to have clearly-documented high-level semantics. I'm not sure how to address #1, as the complexity is necessary. Did you run this through some unit tests, at least? > +{ [snip] > +} Brian
On Thu, 20 Nov 2014 01:22:09 -0800 Brian Norris <computersforpeace@gmail.com> wrote: > On Mon, Oct 20, 2014 at 10:46:15AM +0200, Boris Brezillon wrote: > > Add a new function to move bits (not bytes) from a memory region to > > another one. > > This function is similar to memmove except it acts at bit level. > > This function is needed to implement GPMI raw access functions, given the > > fact that ECC engine does not pad ECC bits to the next byte boundary. > > > > Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com> > > --- > > drivers/mtd/nand/gpmi-nand/gpmi-lib.c | 129 +++++++++++++++++++++++++++++++++ > > drivers/mtd/nand/gpmi-nand/gpmi-nand.h | 4 + > > 2 files changed, 133 insertions(+) > > > > diff --git a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > > index 87e658c..5d4f140 100644 > > --- a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > > +++ b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > > @@ -1353,3 +1353,132 @@ int gpmi_read_page(struct gpmi_nand_data *this, > > set_dma_type(this, DMA_FOR_READ_ECC_PAGE); > > return start_dma_with_bch_irq(this, desc); > > } > > + > > +void gpmi_move_bits(u8 *dst, size_t dst_bit_off, > > + const u8 *src, size_t src_bit_off, > > + size_t nbits) > > Two things: > > 1) Yikes! This function is a little hairy. Yes I know, and if you see a much simpler algorithm to do that, I'm really interested :-). > > 2) This function really deserves a full comment header (kerneldoc?); it > needs to have clearly-documented high-level semantics. I'll add a kernel doc header. > > I'm not sure how to address #1, as the complexity is necessary. Did you > run this through some unit tests, at least? No, but I did test it with several ECC configs. Anyway, if I develop such unit tests, do you want me to put them in the driver code (under an #ifdef section) ?
On Thu, Nov 20, 2014 at 10:42:53AM +0100, Boris Brezillon wrote: > On Thu, 20 Nov 2014 01:22:09 -0800 Brian Norris <computersforpeace@gmail.com> wrote: > > On Mon, Oct 20, 2014 at 10:46:15AM +0200, Boris Brezillon wrote: > > > Add a new function to move bits (not bytes) from a memory region to > > > another one. > > > This function is similar to memmove except it acts at bit level. > > > This function is needed to implement GPMI raw access functions, given the > > > fact that ECC engine does not pad ECC bits to the next byte boundary. > > > > > > Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com> > > > --- > > > drivers/mtd/nand/gpmi-nand/gpmi-lib.c | 129 +++++++++++++++++++++++++++++++++ > > > drivers/mtd/nand/gpmi-nand/gpmi-nand.h | 4 + > > > 2 files changed, 133 insertions(+) > > > > > > diff --git a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > > > index 87e658c..5d4f140 100644 > > > --- a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > > > +++ b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c > > > @@ -1353,3 +1353,132 @@ int gpmi_read_page(struct gpmi_nand_data *this, > > > set_dma_type(this, DMA_FOR_READ_ECC_PAGE); > > > return start_dma_with_bch_irq(this, desc); > > > } > > > + > > > +void gpmi_move_bits(u8 *dst, size_t dst_bit_off, > > > + const u8 *src, size_t src_bit_off, > > > + size_t nbits) > > > > Two things: > > > > 1) Yikes! This function is a little hairy. > > Yes I know, and if you see a much simpler algorithm to do that, I'm > really interested :-). No ideas at the moment :) > > 2) This function really deserves a full comment header (kerneldoc?); it > > needs to have clearly-documented high-level semantics. > > I'll add a kernel doc header. > > > > > I'm not sure how to address #1, as the complexity is necessary. Did you > > run this through some unit tests, at least? > > No, but I did test it with several ECC configs. > Anyway, if I develop such unit tests, do you want me to put them in the > driver code (under an #ifdef section) ? I dunno, that seems like it might just clutter the file more, and I'm not sure if anyone is likely to run them. I was mostly curious how you've verified it. Brian
diff --git a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c index 87e658c..5d4f140 100644 --- a/drivers/mtd/nand/gpmi-nand/gpmi-lib.c +++ b/drivers/mtd/nand/gpmi-nand/gpmi-lib.c @@ -1353,3 +1353,132 @@ int gpmi_read_page(struct gpmi_nand_data *this, set_dma_type(this, DMA_FOR_READ_ECC_PAGE); return start_dma_with_bch_irq(this, desc); } + +void gpmi_move_bits(u8 *dst, size_t dst_bit_off, + const u8 *src, size_t src_bit_off, + size_t nbits) +{ + size_t i; + size_t nbytes; + u32 src_byte = 0; + + /* + * Move src and dst pointers to the closest byte pointer and store bit + * offsets within a byte. + */ + src += src_bit_off / 8; + src_bit_off %= 8; + + dst += dst_bit_off / 8; + dst_bit_off %= 8; + + /* + * Initialize the src_byte value with bits available in the first byte + * of data so that we end up with a byte aligned src pointer. + */ + if (src_bit_off) { + src_byte = src[0] >> src_bit_off; + nbits -= 8 - src_bit_off; + src++; + } + + /* Calculate the number of bytes that can be copied from src to dst. */ + nbytes = nbits / 8; + + /* Try to align dst to a byte boundary. */ + if (dst_bit_off) { + if (src_bit_off <= dst_bit_off) { + dst[0] &= GENMASK(dst_bit_off - 1, 0); + dst[0] |= src_byte << dst_bit_off; + src_bit_off += (8 - dst_bit_off); + src_byte >>= (8 - dst_bit_off); + dst_bit_off = 0; + dst++; + } else if (nbytes) { + src_byte |= src[0] << (8 - src_bit_off); + dst[0] &= GENMASK(dst_bit_off - 1, 0); + dst[0] |= src_byte << dst_bit_off; + src_bit_off += dst_bit_off; + src_byte >>= (8 - dst_bit_off); + dst_bit_off = 0; + dst++; + nbytes--; + src++; + if (src_bit_off > 7) { + src_bit_off -= 8; + dst[0] = src_byte; + dst++; + src_byte >>= 8; + } + } + } + + if (!src_bit_off && !dst_bit_off) { + /* + * Both src and dst pointers are byte aligned, thus we can + * just use the optimized memcpy function. + */ + if (nbytes) + memcpy(dst, src, nbytes); + } else { + /* + * src buffer is not byte aligned, hence we have to copy each + * src byte to the src_byte variable before extracting a byte + * to store in dst. + */ + for (i = 0; i < nbytes; i++) { + src_byte |= src[i] << (8 - src_bit_off); + dst[i] = src_byte; + src_byte >>= 8; + } + } + + /* Update dst and src pointers */ + dst += nbytes; + src += nbytes; + + /* + * nbits is the number of remaining bits. It should not exceed 8 as + * we've already copied as much bytes as possible. + */ + nbits %= 8; + + /* + * If there's no more bits to copy to the destination and src buffer + * was already byte aligned, then we're done. + */ + if (!nbits && !src_bit_off) + return; + + /* Copy the remaining bits to src_byte */ + if (nbits) + src_byte |= (*src & GENMASK(nbits - 1, 0)) << + ((8 - src_bit_off) % 8); + nbits += (8 - src_bit_off) % 8; + + /* + * In case there were not enough bits to get a byte aligned dst buffer + * prepare the src_byte variable to match the dst organization (shift + * src_byte by dst_bit_off and retrieve the least significant bits from + * dst). + */ + if (dst_bit_off) + src_byte = (src_byte << dst_bit_off) | + (*dst & GENMASK(dst_bit_off - 1, 0)); + nbits += dst_bit_off; + + /* + * Keep most significant bits from dst if we end up with an unaligned + * number bits. + */ + if (nbits % 8) + src_byte |= (dst[nbits / 8] & GENMASK(7, nbits % 8)) << + (nbits / 8); + + /* Copy the remaining bytes to dst */ + nbytes = DIV_ROUND_UP(nbits, 8); + for (i = 0; i < nbytes; i++) { + dst[i] = src_byte; + src_byte >>= 8; + } +} diff --git a/drivers/mtd/nand/gpmi-nand/gpmi-nand.h b/drivers/mtd/nand/gpmi-nand/gpmi-nand.h index 32c6ba4..17d0736 100644 --- a/drivers/mtd/nand/gpmi-nand/gpmi-nand.h +++ b/drivers/mtd/nand/gpmi-nand/gpmi-nand.h @@ -290,6 +290,10 @@ extern int gpmi_send_page(struct gpmi_nand_data *, extern int gpmi_read_page(struct gpmi_nand_data *, dma_addr_t payload, dma_addr_t auxiliary); +void gpmi_move_bits(u8 *dst, size_t dst_bit_off, + const u8 *src, size_t src_bit_off, + size_t nbits); + /* BCH : Status Block Completion Codes */ #define STATUS_GOOD 0x00 #define STATUS_ERASED 0xff
Add a new function to move bits (not bytes) from a memory region to another one. This function is similar to memmove except it acts at bit level. This function is needed to implement GPMI raw access functions, given the fact that ECC engine does not pad ECC bits to the next byte boundary. Signed-off-by: Boris Brezillon <boris.brezillon@free-electrons.com> --- drivers/mtd/nand/gpmi-nand/gpmi-lib.c | 129 +++++++++++++++++++++++++++++++++ drivers/mtd/nand/gpmi-nand/gpmi-nand.h | 4 + 2 files changed, 133 insertions(+)